diff --git a/RBD-Notes.txt b/RBD-Notes.txt deleted file mode 100644 index 977ae65..0000000 --- a/RBD-Notes.txt +++ /dev/null @@ -1,264 +0,0 @@ -Alpyca Device - Sample/Template Alpaca (Rotator device) -------------------------------------------------------- -28-Dec-2022 Starting to make notes. I got quite a ways along with this. Now I want to set up -to do the docs ion Sphinx. I don't plan to extract info from docstrings just to keep the -code from being cluttered. I have put comments into the source in plain # form. -Now to set up for making Sphinx docs. What a process. Although I made the Alpyca docs, -and a start on the ASCOM Master docs, using Sphinx and rinohtype, it was so full of crazy -tinkering and problem hunting I just wanted to forget it all Hance these notes so I can -save myself from a fresh round of (repeat) frustrations. - -So starting with the RBD-Notes from the Alpyca project and using VSCode for RST writing: - -* (21-Jul-2022) Install the Sphinx-related packages into the .venv get all of the sphinx and -rinoh pieces into the .venv because the reStructuredText extension depends on the esbonio -language server, and that is actually real-time rendering the document at design time! -This led to several hours of installing shit. - ==== AHHHH ==== - Look at the docs/source/conf.py and those things are in the extensions. REDO THE VENV... AGAIN!!! -* This time I created the venv python -m venv .venv and restarted VSCode. It found the .venv OK. Then I followed - the prompts to install docutils and esbonio, RESTART, then again via "Problems" to install rinohtype RESTART - then again to get sphinx_rtd_theme, which BACK-REVVED DOCUTILS to 0.17.1. Damn. These things are in the Sphinx - conf.py file, which was getting confused with mine before I renamed it. -* ==== HOORAY ==== The reStructruredText extension is working!! It found the junk .rst files I put there as place - holders. Now I need to clean up the Sphinx conf.py ... done. -* Moved over to the RPi. I installed Sphinx, the rsStructuredText VSCode plugin popped up installs for docutils, - and esbonio. I restarted, esbonio can't install the rinoh.frontend.sphinx plugin. I installed rinohtype - pip install rinohtype. No luck even after starting VSCode. So I went to https://github.com/brechtm/rinohtype - and found how to install the latest version via pip/GitHub: - https://github.com/brechtm/rinohtype - This installed markdown-it-py-2.1.0 mdit-py-plugins-0.3.3 mdurl-0.1.2 myst-parser-0.18.1 pyyaml-6.0 - rinohtype-0.5.5, and removed rinohtype-0.5.3. No luck. wtf. It's not showing on the pip list either. - HOW WEIRD - Now same deal with sphinx_rtd_theme. So I used the Pip Manager to install them. Well now - rinoh stuff shows in pip manager but not in the pip list????? Now Esbonio/pip succeeds but without -* Making HTML docs!!! I wanted to disable the "hyperlink not referenced" errors from rstcheck, but -trying to follow the directions in the manual I added a setting "--ignore-errors REGEX_STRING" but no -luck. So I want back into settings restructuredtext: Linters: Disabled-linters, and disabled rstcheck. -This caused restructuedtext to start asking to load the restructuredtext_lint package, so I installed -that with pipmanager. It is there now. -* DAMN - Now it is using rst-lint, a brain damaged linter that doesn't know some of the directives - like .. only:: So I want back and disabled that one. GRRRRR Now it wants doc8. So I installed that with pip. - HOORAY!!! It is using doc8. This one has ways of controlling the errors and other stuff. See the - VSCode settings restructuredtext.linter.doc8.extraArgs and remove the rstcheck shit. Right below - in the JSON are the disabling items. I must hve done this before (dump rstcheck and rst-lint). - Anyway doc8 is finding my errors in real time. - -03-Jan-2023 ------------ -* It is OK to make Sphinx docs on the command line if you deactivate the .venv. That's enough - for now till I decide to get into another wrestling match with version conflicts. TRhe older - versions of packages in the global site-packages all seems to work so DON'T TOUCH IT!!! -* === OH!! ALong the lower left of the VSCode status bar, there is a selector for the Sphinx path!! - I never saw this. It was set to use but I changed it to use Sphinx with the conf.py - info. Maybe this will remove some of the inscrutable linting stuff. - One of the effects is to add this wo the workspace level settings: - "esbonio.sphinx.confDir": "${workspaceFolder}/docs/source", - This makes me realize that esbonio can benefit from not guessing, and that this is project-specific, - so now I will commit the alpaca-device.code-workspace to the Git repo, along with the thunder-tests - in order to create a portable dev environment. -* Shit, esbonio is now building into docs/source/_build instead of docs/build. This is with the - .venv deactivated. Is there no end to the surprises and side effects? - + OK, I have now set up the workspace settings so that esbonio builds into - docs/build/_esbonio/ (doctrees and html), and also Sphinx builds into docs/build - (doctrees and html). - "settings": { - "esbonio.sphinx.confDir": "${workspaceFolder}/docs/source", - "esbonio.sphinx.buildDir": "${workspaceFolder}/docs/build/_esbonio" - } - This makes it easy to .gitignore the esbonio output while keeping it separate from the - actual Sphinx final build output for HTML and rinoh/PDF. - -16-Jan-2023 ------------ - -************************************** -** RESET ON VENV VS GLOBAL ON LINUX ** -************************************** -* Create new .venv2, then activate in VSCode. NOTE: The only way to get this to sork with the 'select interpreter' on the status bar is to first pick "AlpycaDevice ~/Documents" then in the new Select Interpreter list select the one you want! - + Install only falcon and toml, update pip and setuptools. - + DEVELOP WITH .venv2 - + When documenting, in VSCode select the global environment which has all of the shit. THIS WORKS including linting. - + Simply deactivating in the terminal DOES NOT WORK if VSCode is set to .venv2, since the linters etc. aren't instaled. -================ -== CONCLUSION == -================ -* Coding and testing, have VSCode set for .venv2 -* Working on docs, have VSCode set for Global site-packages --- Update Sphinx and linters -- -1. PipMgr Update Sphinx to 6.1.3 - Build OK after removing contents of /build folder (old pickled). esbonio OK 6.1.3 -2. PipMgr Update Doc8 to 1.1.1 -3. PipMgr update rstcheck -> 6.1.1 and rstcheck-core to 1.0.3 -4. PipMgr Update sphinx-autodoc-typehints to 1.21.1, sphinx jinja-compat to 0.2.0, sphinx-rtd-theme to 1.1.1 - sphinx-tabs to 3.4.1, sphinx-toolbox to 3.3.0 -->> SHIT SPHINX IS NOW BACK AT 4.5.0 ?!?!?!?!? -5. PipMgr Refresh, Update Sphinx to 6.1.3, and again sphinx-autodoc-typehints to 1.21.1, DOCS OK. -6. Update zope.interface to 5.5.2 (fron dev version) - -17-Jan-2023 ------------ -* Renamed the repo AlpycaDevice. Renamed root folders on Linux and Windows, adjusted the virtual environment activation scripts -* Removed the messy .venv on Linux and renamed .venv2 from yesterday to .venv. Develop with .venv, do docs with global. -* Rename repo and project root directories to AlpycaDevice. - + Rename repo on GitHub - + Rename root on Windows, fix up .venv/Scripts/activate scripts (multiple). - == Painless on Windows, the .venv activates as before and GitHub still OK == -* At GitHub, the old repo path /alpyca-device still works but does a redirect to the real /AlpycaDevice. - I decided to update the git remote info on Linux and Windows to point to the - new git remote. Under VSCode Remote menu, remove origin. Then add remote from - Git, my AlpycaDevice one. This was a snap on Linux, Clicking the Publish To - just fixed it up. On Windows I had to - git branch --set-upstream-to=origin/master master - to get it to work again. All OK in the end. -* Well one remaining issue - On Windows, in the .venv (the original), the sphinx-build.exe has embedded in it - the old path alpyca-device. WTF? So renaming the project root to AlpycaDevice - caused this. How did that venv path get into Scripts\sphinx-build.exe? Guess: - when installed into .venv. Well this is even worse. pip doesn't even work. - ooks like the end of the .venv on Windows too. Forget this venv too!!! -* WINDOWS == Same usage of .venv for dev, global for doc. Killed the old messy .venv, created a new one - with just pip, setuptools, falcon, and toml. If you select that interpreter the doc tools will croak. - That's fine. Don't open a .rst doc when running on the .venv. -* In global, many packages updated using pip-manager in VSCode. Specifically the sphinx-related ones - were updated. Sphinx is limited to 5.3.0 owing to the Python on this system being limited to 3.7. - After this esbonioneeded to be updated too. Done. - -18-Jan-2022 ------------ -* Holy smokes! The Rewrap plugin (by stkb) is the BOMB! Alt-q and it is smart enough to wrap - a lot of the structures use by reST. I love it. Just write, and when the paragraph is finished - or edited chopped up, alt-q :-) :-) - -* Ideas for writing: -Three types of exceptions here: - 1. Errors in the HTTP request itself -> 400 or 404 - 2. Device operational errors RunTimeError -> Alpaca DeviceException and detailed message with -> 200 -> logged also - 3. Python uncaught exception in the Falcon responder class -> 500 -> Logged also - 4. Python uncaught exception in the app outside Falcon -> Logged and possible app death. - -28-May-2023 ------------ -* On the W10 system, running from global environment, the RST extension is failing to start esbonio for a space in the - command line. The author doesn't give a shit per the GitHub traffic. NOW WHAT? GOD ALMIGHTY THIS STUFF IS SOOOOOO - FRAGILE. I seem to recall that I needed to revert to 189.1.0..... I did it and now it works. DAMN! I opened the - Extension page and the "Update to 189.3.0 dropdown has an option "Ignore Updates". I did it. That "cured" the - problem. You should see the traffic on GitHub for the RestructuredText extension. The author says "well no - one uses Windows anyway"" yet it worked fine 2 releases previous. - - #################################################################### - ### DO NOT UPDATE THE RESTRUCTURED TEXT EXTENSION BEYOND 189.1.0 ### - #################################################################### - -01-Jun-2023 ------------ -* RST previewer isn't working right for my CHANGES.rst. Yeah, the CHANGES.rst file did not get compiled. -Apparently, the preview feature depends on the RST file being compiled by esbonio. Running it does not compile -CHANGES.rst because it is outside the docs folder. It is not part of the docs but there for viewing on GitHub -at the rood of the folder tree. No preview on this. - -* I keep getting this cryptic message while editing RST docs with a squiggle yellow at the end of the editor. - RuntimeWarning: 'doc8.main' found in sys.modules after import of package 'doc8', but prior to execution - of 'doc8.main'; this may result in unpredictable behaviour - Great. Try to find any info on this ha ha ha. I'm pretty sure doc8 is an RST linter? This should be fun.... - -* Reminder frm a horrible wrestling match on another project where the PDF construction in Sphinx (rinohtype) - dies for any Sphinx runs. This turned out to be the importlib-metadata packate (Python) which nededs to stay - at 4.1.4. Maybe later but I don't have time to look at this. Apparently as I recall there wa sa breaking API - change with V6 that sacorched Sphinx and/or Rinoh. - - ########################################################################## - ### DO NOT ALLOW PYTHON PKG IMPORTLIB-METADATA TO UPDATE BEYOND 4.11.4 ### - ########################################################################## - -02-Jun-2023 ------------ -* After suffering with inscrutable gigantic errors in the Esbonio output window, yellow squiggles in - random places seemingly at a given line regardless of the content at that location, I disabled - the doc8 and rst-lint linters, leaving rstcheck. I vaguely recall a wrestling match with rstcheck - last year but I'm sick of this **** so bye-bye. The random balloon popups and output-filling casdading - errors are now gone. Thank goodness. -* To do the preceding I had to edit the VSCode JSON settings. Now the CTRL-K + CTRL-R for open - RST preview to the side and CTRL-SHFT-R to open RST preview in a tab have been covered. They are still - in the Keyboard Commands list, but CTRL-K + CTRL-R opens keyboard-shortcuts-windows.pdf in the PDF - reader, and CTRL-SHFT-R opens the Thunder Client pane on the left. I found 'thunder' in the mappings - and removed that one, and 'shortcuts' revealed help keboard shortcuts reference and I removed that. - I'm sure I'm gonna need to do this again. - -15-Feb-2024 ------------ -* ThunderClient stopped working because it wanted a subscription to store the activity and collections -along with the workspace. I subscribed but the ****ing activation process requirees email on your -development machine (long story!). I really wanted the collections I made to test AlpycaDevice SDK -The files in the ThunderTests workspace folder are where they are, but Thunder can no longer use -them without $35/year. In thunder settings you have to shut off the Workspace Data setting. -Reading their docs, I found that by moving the collection JSON files to -%APPDATA%\Code\User\globalStorage\rangav.vscode-thunder-client -I can again use Thunder. This is not an issue with the Thunder on the old Win7 system which -is 2.4.3. Well I reverted to 2.4.3 on the Windows 10 system and it can't find the stuff in the -workspace so to hell with it. - -16-Feb-2024 ------------ -* I had a few messages with Thunder and they had to make a change. After doing so, I was able to -successfully register ThunderClient on the main W10 system so now I can keep the ThunderClient -requests within the AlpycaDevice workspace once again. This is good. - -17-Feb-2024 ------------ -* Back to this s**t - RuntimeWarning: 'doc8.main' found in sys.modules after import of package 'doc8', - but prior to execution of 'doc8.main'; this may result in unpredictable behaviour" -This time, in User settings (W10 system), reStructuredText, Disabled Linters, add doc8 -along with rst-check, leaving rstcheck as the linter. Good enough. - -05-Mar-2024 ------------ -* Using the most recent (March 2) JSON from the OmniSimulator, the templates were rebuilt. - CoverCalibrator now has the formerly missing members. -* Added OperationCancelledException -* Docs for the 0.7.0 built. - -13-Sep-2024 ------------ -* Decided no 0.8 but to go with 1.0 in the platform7 branch -* Add separate enum definitions in files under templates/enum, then merge the enum blocks into the - templates during generation. Required a changes to the device boilerplate app.py to avoid trying - to make a responder for the enum classes. -* Start on final 1.0 docs - Migration Guide. Not going to make PDF for this due to many links for - opening externals in separate tabs, which don't work in PDF. - -14-Sep-2024 ------------ -* Complete Migration Guide, style enhancements, fix a few cross-references etc. -* Change copyrights to cover thru 2024 -* Update tests to use latest ConformU Version 3.1.0 (Build 31181.cb32ac3), include latest logs. - -08-Oct-2024 ------------ -* Merge platform 76 branch onto master. -* Re-do HTML docs and publish in regular place /public_html/ascomsite/alpycadevice and dump temporary alpycadevice7 folder -* As usual PDF fails. Put in the Rinoh fix Desc_Sig_Space see conf.py at the top. SUCCEEDED!!!!! - -04-Jan-2025 ------------ -* See GitHub Issue #15 https://github.com/ASCOMInitiative/AlpycaDevice/issues/15 ... the OmniSimulators 0.4.1 has 'ID' in the Switch method parameters. ConformU 4.1.0 tests OmniSim 0.4.1 successfully. So which is it??? - -07-Jan-2025 ------------ -* It's 'Id' as in the Master Interfaces. Peter fixed the OmniSim and gave me a new JSON input for the templates AlpacaDeviceAPI_v2_plat7-0.4.1.json - -05-Feb-2025 ------------ -* 1.0.1 Regenerated templates for the Id thing and for Fix #16 for property Connected on_put() and a typo. 1.0.1. - -16-Feb-2025 ------------ -* Fix ClientID and ClientTransactionID in shr.py per GitHub #17. Release 1.0.2 - -20-Feb-2025 ------------ -* ALERT: USE THE SYSTEMWIDE P11 INTERPRETER NOT VIRTUAL ENVIRONMENT FOR DOCUMENT LINTING AND BUILDING - - It appears that the RST is syntax colored byt not linted. No esbonio, etc. -* Back to review the rotator device for threading and timers, and FRAGILITY ALERT there are errors in conf.py - - No module named 'rinoh' [Ln 10, Col1] - - Import "rinoh.frontend.rst" could not be resolved [Ln 10, Col 6] - -> from rinoh.frontend.rst import DocutilsInlineNode - - Nonetheless the PDF Builds!! ** NEVER MIND ** - diff --git a/alpaca-device.mustache b/alpaca-device.mustache deleted file mode 100644 index 60d2847..0000000 --- a/alpaca-device.mustache +++ /dev/null @@ -1,40 +0,0 @@ -{{! Alpaca Docstring Template - Derived from Google by Bob Denny 10-Apr-2022}} -{{! We always want raises and remarks sections, no Yields}} -{{summaryPlaceholder}} - -{{extendedSummaryPlaceholder}} -{{#parametersExist}} - -Args: -{{#args}} - {{var}} ({{typePlaceholder}}): {{descriptionPlaceholder}} -{{/args}} -{{#kwargs}} - {{var}} ({{typePlaceholder}}, optional): {{descriptionPlaceholder}}. Defaults to {{&default}}. -{{/kwargs}} -{{/parametersExist}} -{{#returnsExist}} - -Returns: -{{#returns}} - {{typePlaceholder}}: {{descriptionPlaceholder}} -{{/returns}} -{{/returnsExist}} - -Raises: -{{#exceptionsExist}} -{{#exceptions}} - {{type}}: {{descriptionPlaceholder}} -{{/exceptions}} -{{/exceptionsExist}} - {{descriptionPlaceholder}}Exception: {{descriptionPlaceholder}} - {{descriptionPlaceholder}}Exception: {{descriptionPlaceholder}} - DriverException: An error occurred that is not described by - one of the more specific ASCOM exceptions. - The device did not *successfully* complete the request. -{{#placeholder}} -Notes: - * {{descriptionPlaceholder}} - * {{descriptionPlaceholder}} - * {{descriptionPlaceholder}} -{{/placeholder}} \ No newline at end of file diff --git a/device/app.py b/device/app.py index 9c25e7f..bc24963 100644 --- a/device/app.py +++ b/device/app.py @@ -77,7 +77,7 @@ ############################## # FOR EACH ASCOM DEVICE TYPE # ############################## -import rotator +import observingconditions #-------------- API_VERSION = 1 @@ -140,7 +140,7 @@ def init_routes(app: App, devname: str, module): Args: app (App): The instance of the Falcon processor app - devname (str): The name of the device (e.g. 'rotator") + devname (str): The name of the device (e.g. 'observingconditions") module (module): Module object containing responder classes Notes: @@ -223,14 +223,14 @@ def main(): # Share this logger throughout log.logger = logger exceptions.logger = logger - rotator.start_rot_device(logger) + #observingconditions.start_rot_device(logger) discovery.logger = logger set_shr_logger(logger) ######################### # FOR EACH ASCOM DEVICE # ######################### - rotator.logger = logger + observingconditions.logger = logger # ----------------------------- # Last-Chance Exception Handler @@ -253,14 +253,14 @@ def main(): ######################### # FOR EACH ASCOM DEVICE # ######################### - init_routes(falc_app, 'rotator', rotator) + init_routes(falc_app, 'observingconditions', observingconditions) # # Initialize routes for Alpaca support endpoints falc_app.add_route('/management/apiversions', management.apiversions()) falc_app.add_route(f'/management/v{API_VERSION}/description', management.description()) falc_app.add_route(f'/management/v{API_VERSION}/configureddevices', management.configureddevices()) falc_app.add_route('/setup', setup.svrsetup()) - falc_app.add_route(f'/setup/v{API_VERSION}/rotator/{{devnum}}/setup', setup.devsetup()) + falc_app.add_route(f'/setup/v{API_VERSION}/observingconditions/{{devnum}}/setup', setup.devsetup()) # # Install the unhandled exception processor. See above, diff --git a/device/config.toml b/device/config.toml index bb8523e..27188d3 100644 --- a/device/config.toml +++ b/device/config.toml @@ -5,7 +5,7 @@ ip_address = '' # Any address port = 5555 [server] -location = 'Anywhere on Earth' # Anything you want here +location = 'Obs in Lauchhammer' # Anything you want here verbose_driver_exceptions = true [device] diff --git a/device/management.py b/device/management.py index a5ae815..671604c 100644 --- a/device/management.py +++ b/device/management.py @@ -47,7 +47,7 @@ from config import Config from logging import Logger # For each *type* of device served -from rotator import RotatorMetadata +from observingconditions import ObservingconditionsMetadata logger: Logger = None #logger = None # Safe on Python 3.7 but no intellisense in VSCode etc. @@ -84,10 +84,10 @@ class configureddevices(): def on_get(self, req: Request, resp: Response): confarray = [ # TODO ADD ONE FOR EACH DEVICE TYPE AND INSTANCE SERVED { - 'DeviceName' : RotatorMetadata.Name, - 'DeviceType' : RotatorMetadata.DeviceType, + 'DeviceName' : ObservingconditionsMetadata.Name, + 'DeviceType' : ObservingconditionsMetadata.DeviceType, 'DeviceNumber' : 0, - 'UniqueID' : RotatorMetadata.DeviceID + 'UniqueID' : ObservingconditionsMetadata.DeviceID } ] resp.text = PropertyResponse(confarray, req).json diff --git a/templates/observingconditions.py b/device/observingconditions.py similarity index 60% rename from templates/observingconditions.py rename to device/observingconditions.py index 74d7df1..c1ede92 100644 --- a/templates/observingconditions.py +++ b/device/observingconditions.py @@ -1,24 +1,144 @@ - +#! /usr/bin/env python # -*- coding: utf-8 -*- # # ----------------------------------------------------------------------------- # observingconditions.py - Alpaca API responders for Observingconditions # -# Author: Your R. Name (abc) +# Author: Gunter Georgi (geo) # # ----------------------------------------------------------------------------- # Edit History: # Generated by Python Interface Generator for AlpycaDevice # -# ??-???-???? abc Initial edit +# 25.Feb. 2025 geo Initial edit +# 01. Mrz 2025 geo partiell arbeitsfähig +# 11. Mrz 2025 geo Verbesserung der raindetection +# 16. Mrz.2025 geo all functions are running but optimization required +# 20. Mrz.2025 geo exp. regression for cloudcover programmed - working + + from falcon import Request, Response, HTTPBadRequest, before from logging import Logger from shr import PropertyResponse, MethodResponse, PreProcessRequest, \ StateValue, get_request_field, to_bool from exceptions import * # Nothing but exception classes - -logger: Logger = None +import smbus2 +import board # installiere Adafruit-Board - wichtig! +import busio +import adafruit_tsl2591 +import adafruit_mlx90614 +from datetime import datetime +import threading +import json +import os +from time import sleep +from micropython import const +from numpy import sign +from math import log10,log,exp,pow +import requests +from w1thermsensor import W1ThermSensor, Unit +import RPi.GPIO as GPIO +import time + + +# bedarf pip install rpi.lgpio!! + + +# Global variables + +rain_pin=23 +rain_vol = 0. +rain_pin_counter=0 +last_drop_time=time.time() +Tobj = None # Globale Variable für Objekt-Temperatur +SENSOR_JSON_PATH = "/home/geo/Arbeitsplatz/Weatherdata/sensor-readings.json" +print ("Starzeit: ", last_drop_time) +def write_sensor_json(): + global Tobj, rain_vol, rain_pin_counter + while True: + try: + # Zeitstempel + timestamp = datetime.utcnow().isoformat() + # Werte auslesen (Tobj wird im cloudcover-Handler gesetzt, rain_vol im rainrate-Handler) + # Fallback: Wenn Tobj None, versuche aktuellen Wert zu lesen + if Tobj is None: + try: + i2c = busio.I2C(board.SCL, board.SDA) + mlx = adafruit_mlx90614.MLX90614(i2c) + current_Tobj = mlx.object_temperature + except Exception: + current_Tobj = None + else: + current_Tobj = Tobj + + # brightness.lux und tsl.lux auslesen + try: + i2c2 = busio.I2C(board.SCL, board.SDA) + brightness = adafruit_tsl2591.TSL2591(i2c2) + brightness_lux = brightness.lux + except Exception: + brightness_lux = None + + try: + i2c3 = busio.I2C(board.SCL, board.SDA) + tsl = adafruit_tsl2591.TSL2591(i2c3) + tsl_lux = tsl.lux + except Exception: + tsl_lux = None + + data = { + "timestamp": timestamp, + "Tobj": current_Tobj, + "rain_vol": rain_vol, + "rain_pin_counter": rain_pin_counter, + "brightness_lux": brightness_lux, + "tsl_lux": tsl_lux + } + # Datei schreiben (append, falls Datei existiert, sonst neu) + if os.path.exists(SENSOR_JSON_PATH): + with open(SENSOR_JSON_PATH, "r+") as f: + try: + arr = json.load(f) + if not isinstance(arr, list): + arr = [] + except Exception: + arr = [] + arr.append(data) + f.seek(0) + json.dump(arr, f, indent=2) + f.truncate() + else: + with open(SENSOR_JSON_PATH, "w") as f: + json.dump([data], f, indent=2) + except Exception as e: + print(f"Fehler beim Schreiben der Sensorwerte: {e}") + sleep(300) # 5 Minuten + +# Starte Hintergrund-Thread beim Modulimport +threading.Thread(target=write_sensor_json, daemon=True).start() + + +# RG-11 Regensensor ab Zeile 360 +GPIO.setmode(GPIO.BCM) +GPIO.setup(rain_pin, GPIO.IN,pull_up_down=GPIO.PUD_UP) + +# Globale callback Funktion für RG-11 +def rain_pin_handler(pin): + global rain_pin, rain_pin_counter, last_drop_time + rain_pin_counter +=1 + last_drop_time=time.time() + print("IRQ: letzter Tropfen um: ", last_drop_time) + + + +GPIO.add_event_detect(23, GPIO.BOTH,rain_pin_handler) + +# Internal constants: +_MLX90614_I2CADDR = const(0x5A) +_MLX90614_TA = const(0x06) +_MLX90614_TOBJ1 = const(0x07) +_MLX90614_CONFIG = const(0x25) # ---------------------- # MULTI-INSTANCE SUPPORT @@ -29,7 +149,7 @@ # set to 0 for the simple case of controlling only one instance of this device type. # maxdev = 0 # Single instance - +is_conn = True # ----------- # DEVICE INFO # ----------- @@ -37,14 +157,14 @@ ## EDIT FOR YOUR DEVICE ## class ObservingconditionsMetadata: """ Metadata describing the Observingconditions Device. Edit for your device""" - Name = 'Sample Observingconditions' - Version = '##DRIVER VERSION AS STRING##' - Description = 'My ASCOM Observingconditions' + Name = 'ObsBedingungen' + Version = 'V001' + Description = ' Wetter und SeeingSensoren' DeviceType = 'Observingconditions' - DeviceID = '##GENERATE A NEW GUID AND PASTE HERE##' # https://guidgenerator.com/online-guid-generator.aspx - Info = 'Alpaca Sample Device\nImplements IObservingconditions\nASCOM Initiative' + DeviceID = '9243a204-804f-4598-8c1c-24465d1dc253' # https://guidgenerator.com/online-guid-generator.aspx + Info = 'Alpaca Device\nImplements IObservingconditions\nASCOM Initiative' MaxDeviceNumber = maxdev - InterfaceVersion = ##YOUR DEVICE INTERFACE VERSION## # IObservingconditionsVxxx + InterfaceVersion = "IObservingconditionsV001" # IObservingconditionsVxxx # -------------------- @@ -88,7 +208,7 @@ class connected: def on_get(self, req: Request, resp: Response, devnum: int): try: # ------------------------------------- - is_conn = ### READ CONN STATE ### + is_conn = True ### READ CONN STATE ### # ------------------------------------- resp.text = PropertyResponse(is_conn, req).json except Exception as ex: @@ -112,7 +232,7 @@ class connecting: def on_get(self, req: Request, resp: Response, devnum: int): try: # ------------------------------ - val = ## GET CONNECTING STATE ## + val = True # ------------------------------ resp.text = PropertyResponse(val, req).json except Exception as ex: @@ -128,7 +248,7 @@ def on_get(self, req: Request, resp: Response, devnum: int): class devicestate: def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: + if not is_conn: ##IS DEV CONNECTED##: resp.text = PropertyResponse(None, req, NotConnectedException()).json return @@ -148,7 +268,7 @@ class disconnect: def on_put(self, req: Request, resp: Response, devnum: int): try: # --------------------------- - ### DISCONNECT THE DEVICE ### + is_conn = False ### DISCONNECT THE DEVICE ### # --------------------------- resp.text = MethodResponse(req).json except Exception as ex: @@ -184,14 +304,14 @@ def on_get(self, req: Request, resp: Response, devnum: int): class averageperiod: def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: + if not is_conn: ##IS DEV CONNECTED##: resp.text = PropertyResponse(None, req, NotConnectedException()).json return try: # ---------------------- - val = ## GET PROPERTY ## + val = 3 ## GET PROPERTY ## # ---------------------- resp.text = PropertyResponse(val, req).json except Exception as ex: @@ -199,7 +319,7 @@ def on_get(self, req: Request, resp: Response, devnum: int): DriverException(0x500, 'Observingconditions.Averageperiod failed', ex)).json def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: + if not is_conn: ## IS DEV CONNECTED ##: resp.text = PropertyResponse(None, req, NotConnectedException()).json return @@ -224,105 +344,81 @@ def on_put(self, req: Request, resp: Response, devnum: int): @before(PreProcessRequest(maxdev)) class cloudcover: - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Observingconditions.Cloudcover failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class dewpoint: def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: + if not is_conn: ##IS DEV CONNECTED##: resp.text = PropertyResponse(None, req, NotConnectedException()).json return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Observingconditions.Dewpoint failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class humidity: - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- + i2c = busio.I2C(board.SCL, board.SDA) + K1 = 50. + K2 = 110. + K3 = 4. + K4 = 100. + K5 = 100. + K6 = 10. + K7 = 100. + mlx = adafruit_mlx90614.MLX90614(i2c) + Tamb=mlx.ambient_temperature -10 + global Tobj + Tobj=mlx.object_temperature + if abs((K2 / 10. - Tamb)) < 1: + T67 = sign(K6) * sign(Tamb - K2 / 10.) * abs((K2 / 10. - Tamb)) + else: + T67 = K6 / 10. * sign(Tamb - K2 / 10.) * (log(abs((K2 / 10. - Tamb))) / log(10.) + K7 / 100.) + + Td = (K1 / 100.) * (Tamb - K2 / 10.) + (K3 / 100.) * pow(exp(K4 / 1000. * Tamb), (K5 / 100.)) + T67 + Tsky=Tobj-Td + #exponentielle Anpassungsgleichung: + val= 16.*exp(0.346574*Tsky) + #print("Tsky; Tamb; Td = ", Tsky,Tamb, Td) + #val=12.5*Tsky+60 resp.text = PropertyResponse(val, req).json except Exception as ex: resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Observingconditions.Humidity failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class pressure: + DriverException(0x500, 'Observingconditions.Cloudcover failed', ex)).json - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Observingconditions.Pressure failed', ex)).json @before(PreProcessRequest(maxdev)) class rainrate: - + def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: + global rain_pin_counter, rain_timer,rain_start, rain_vol + + if not is_conn: ##IS DEV CONNECTED##: resp.text = PropertyResponse(None, req, NotConnectedException()).json return try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json + #print("akt. Zeit im loop: ",time.time()) + if ((time.time()-last_drop_time)>1800): + rain_pin_counter =0 + global rain_vol + rain_vol=round(rain_pin_counter*0.2,2) + #print("Regenvolumen: ",rain_vol) + resp.text = PropertyResponse(rain_vol, req).json + time.sleep(0.01) except Exception as ex: - resp.text = PropertyResponse(None, req, + resp.text = PropertyResponse(None, req, DriverException(0x500, 'Observingconditions.Rainrate failed', ex)).json @before(PreProcessRequest(maxdev)) class skybrightness: def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: + if not is_conn: ##IS DEV CONNECTED##: resp.text = PropertyResponse(None, req, NotConnectedException()).json return try: # ---------------------- - val = ## GET PROPERTY ## + i2c = busio.I2C(board.SCL, board.SDA) + brightness = adafruit_tsl2591.TSL2591(i2c) + val=brightness.lux # ---------------------- resp.text = PropertyResponse(val, req).json except Exception as ex: @@ -333,14 +429,17 @@ def on_get(self, req: Request, resp: Response, devnum: int): class skyquality: def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: + if not is_conn: ##IS DEV CONNECTED##: resp.text = PropertyResponse(None, req, NotConnectedException()).json return - + try: # ---------------------- - val = ## GET PROPERTY ## + i2c = busio.I2C(board.SCL, board.SDA) + tsl=adafruit_tsl2591.TSL2591(i2c) + calFac = 5.7 + val = calFac + (log((tsl.lux / 108000.0), 10) / -0.4) # ---------------------- resp.text = PropertyResponse(val, req).json except Exception as ex: @@ -350,116 +449,69 @@ def on_get(self, req: Request, resp: Response, devnum: int): @before(PreProcessRequest(maxdev)) class skytemperature: - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Observingconditions.Skytemperature failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class starfwhm: +#while True: +# print("Ambent Temp: ", mlx.ambient_temperature) +# print("Object Temp: ", mlx.object_temperature) +# time.sleep(1) - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: + def on_get(self, req: Request, resp: Response, devnum: int): + if not is_conn: ##IS DEV CONNECTED##: resp.text = PropertyResponse(None, req, NotConnectedException()).json return try: # ---------------------- - val = ## GET PROPERTY ## + #i2c = board.I2C() + i2c = busio.I2C(board.SCL, board.SDA) + mlx = adafruit_mlx90614.MLX90614(i2c) + val = mlx.object_temperature # ---------------------- resp.text = PropertyResponse(val, req).json except Exception as ex: resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Observingconditions.Starfwhm failed', ex)).json - + DriverException(0x500, 'Observingconditions.Skytemperature failed', ex)).json +# +# @before(PreProcessRequest(maxdev)) +# class starfwhm: +# +# def on_get(self, req: Request, resp: Response, devnum: int): +# if not is_conn: ##IS DEV CONNECTED##: +# resp.text = PropertyResponse(None, req, +# NotConnectedException()).json +# return +# +# try: +# # ---------------------- +# val = ## GET PROPERTY ## +# # ---------------------- +# resp.text = PropertyResponse(val, req).json +# except Exception as ex: +# resp.text = PropertyResponse(None, req, +# DriverException(0x500, 'Observingconditions.Starfwhm failed', ex)).json +# @before(PreProcessRequest(maxdev)) class temperature: - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Observingconditions.Temperature failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class winddirection: + def on_get(self, req: Request, resp: Response, devnum: int): + if not is_conn: ##IS DEV CONNECTED##: + resp.text = PropertyResponse(None, req, + NotConnectedException()).json + return - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Observingconditions.Winddirection failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class windgust: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Observingconditions.Windgust failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class windspeed: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Observingconditions.Windspeed failed', ex)).json + try: + Innentemp = W1ThermSensor() + caminside = Innentemp.get_temperature() + resp.text = PropertyResponse(caminside, req).json + except Exception as ex: + resp.text = PropertyResponse(None, req, + DriverException(0x500, 'Observingconditions.Dewpoint failed', ex)).json @before(PreProcessRequest(maxdev)) class refresh: def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: + if not is_conn: ## IS DEV CONNECTED ##: resp.text = PropertyResponse(None, req, NotConnectedException()).json return @@ -477,7 +529,7 @@ def on_put(self, req: Request, resp: Response, devnum: int): class sensordescription: def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: + if not is_conn: ##IS DEV CONNECTED##: resp.text = PropertyResponse(None, req, NotConnectedException()).json return @@ -486,7 +538,7 @@ def on_get(self, req: Request, resp: Response, devnum: int): ### INTEPRET AS NEEDED OR FAIL ### # Raise Alpaca InvalidValueException with details! try: # ---------------------- - val = ## GET PROPERTY ## + val = 1 ## GET PROPERTY ## # ---------------------- resp.text = PropertyResponse(val, req).json except Exception as ex: @@ -497,7 +549,7 @@ def on_get(self, req: Request, resp: Response, devnum: int): class timesincelastupdate: def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: + if not is_conn: ##IS DEV CONNECTED##: resp.text = PropertyResponse(None, req, NotConnectedException()).json return @@ -506,7 +558,7 @@ def on_get(self, req: Request, resp: Response, devnum: int): ### INTEPRET AS NEEDED OR FAIL ### # Raise Alpaca InvalidValueException with details! try: # ---------------------- - val = ## GET PROPERTY ## + val = 40 ## GET PROPERTY ## # ---------------------- resp.text = PropertyResponse(val, req).json except Exception as ex: diff --git a/device/requirements.txt b/device/requirements.txt new file mode 100644 index 0000000..0443250 --- /dev/null +++ b/device/requirements.txt @@ -0,0 +1,75 @@ +# packages in environment at /home/geo/miniconda3/envs/alpyca: +# +# Name Version Build Channel +_libgcc_mutex 0.1 main +_openmp_mutex 5.1 51_gnu +adafruit-blinka 8.54.0 pypi_0 pypi +adafruit-circuitpython-bme280 2.6.27 pypi_0 pypi +adafruit-circuitpython-bmp280 3.3.6 pypi_0 pypi +adafruit-circuitpython-busdevice 5.2.11 pypi_0 pypi +adafruit-circuitpython-connectionmanager 3.1.3 pypi_0 pypi +adafruit-circuitpython-dht 4.0.7 pypi_0 pypi +adafruit-circuitpython-mlx90614 1.2.20 pypi_0 pypi +adafruit-circuitpython-register 1.10.2 pypi_0 pypi +adafruit-circuitpython-requests 4.1.9 pypi_0 pypi +adafruit-circuitpython-tsl2561 3.3.20 pypi_0 pypi +adafruit-circuitpython-tsl2591 1.4.2 pypi_0 pypi +adafruit-circuitpython-typing 1.11.2 pypi_0 pypi +adafruit-platformdetect 3.77.0 pypi_0 pypi +adafruit-pureio 1.1.11 pypi_0 pypi +adafruit-python-shell 1.8.1 pypi_0 pypi +alpyca 3.0.0 pypi_0 pypi +args 0.1.0 pypi_0 pypi +binho-host-adapter 0.1.6 pypi_0 pypi +bzip2 1.0.8 h998d150_6 +ca-certificates 2024.12.31 hd43f75c_0 +certifi 2025.1.31 pypi_0 pypi +charset-normalizer 3.4.1 pypi_0 pypi +click 8.1.8 pypi_0 pypi +clint 0.5.1 pypi_0 pypi +colorzero 2.0 pypi_0 pypi +enum-tools 0.9.0.post1 pypi_0 pypi +expat 2.6.4 h419075a_0 +falcon 4.0.2 pypi_0 pypi +gpiozero 2.0.1 pypi_0 pypi +idna 3.10 pypi_0 pypi +ld_impl_linux-aarch64 2.40 h48e3ba3_0 +lgpio 0.2.2.0 pypi_0 pypi +libffi 3.4.4 h419075a_1 +libgcc-ng 11.2.0 h1234567_1 +libgomp 11.2.0 h1234567_1 +libstdcxx-ng 11.2.0 h1234567_1 +libuuid 1.41.5 h998d150_0 +machine 0.0.1 pypi_0 pypi +ncurses 6.4 h419075a_0 +netifaces 0.11.0 pypi_0 pypi +numpy 2.2.3 pypi_0 pypi +openssl 3.0.15 h998d150_0 +pigpio 1.78 pypi_0 pypi +pip 25.0 py312hd43f75c_0 +pycrypto 2.6.1 pypi_0 pypi +pyftdi 0.56.0 pypi_0 pypi +pygments 2.19.1 pypi_0 pypi +pyserial 3.5 pypi_0 pypi +python 3.12.9 h8edadfe_0 +python-dateutil 2.9.0.post0 pypi_0 pypi +pyusb 1.3.1 pypi_0 pypi +readline 8.2 h998d150_0 +requests 2.32.3 pypi_0 pypi +rpi-gpio 0.7.1 pypi_0 pypi +rpi-lgpio 0.6 pypi_0 pypi +rpi-ws281x 5.0.0 pypi_0 pypi +setuptools 75.8.1 pypi_0 pypi +six 1.17.0 pypi_0 pypi +smbus2 0.5.0 pypi_0 pypi +sqlite 3.45.3 h998d150_0 +sysv-ipc 1.1.0 pypi_0 pypi +tk 8.6.14 h987d8db_0 +toml 0.10.2 pypi_0 pypi +typing-extensions 4.12.2 pypi_0 pypi +tzdata 2025a h04d1e81_0 +urllib3 2.3.0 pypi_0 pypi +w1thermsensor 2.3.0 pypi_0 pypi +wheel 0.45.1 py312hd43f75c_0 +xz 5.6.4 h998d150_1 +zlib 1.2.13 h998d150_1 diff --git a/device/rotator.py b/device/rotator.py deleted file mode 100644 index 0151769..0000000 --- a/device/rotator.py +++ /dev/null @@ -1,616 +0,0 @@ -# -*- coding: utf-8 -*- -# ----------------------------------------------------------------------------- -# rotator.py - Endpoints for members of ASCOM Alpaca Rotator Device -# -# Part of the AlpycaDevice Alpaca skeleton/template device driver -# -# Author: Robert B. Denny (rbd) -# -# Implements: ASCOM IRotatorV4 interface -# https://ascom-standards.org/newdocs/rotator.html#Rotator -# Python Compatibility: Requires Python 3.7 or later -# GitHub: https://github.com/ASCOMInitiative/AlpycaDevice -# -# ----------------------------------------------------------------------------- -# MIT License -# -# Copyright (c) 2022-2024 Bob Denny -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. -# ----------------------------------------------------------------------------- -# Edit History: -# 16-Dec-2022 rbd 0.1 Initial edit for Alpaca sample/template -# 18-Dec-2022 rbd 0.1 For upgraded exception classes -# 19-Dec-2022 rbd 0.1 Implement all IRotatorV3 endpoints -# 24-Dec-2022 rbd 0.1 Logging -# 25-Dec-2022 rbd 0.1 Logging typing for intellisense -# 26-Dec-2022 rbd 0.1 Logging of endpoints -# 27-Dec-2022 rbd 0.1 Revamp logging so request precedes -# response. Minimize imported stuff. MIT license -# and module header. -# 30-Dec-2022 rbd 0.1 Revamp request pre-processing, logging, and -# quality control. Device number from URI. -# 31-Dec-2022 rbd 0.1 Bad boolean values return 400 Bad Request -# 15-Jan-2023 rbd 0.1 Documentation. No logic changes. -# 20-Jan-2023 rbd 0.1 Refactor for clarity -# 23-May-2023 rbd 0.2 Refactoring for multiple ASCOM device type support -# GitHub issue #1 -# 30-May-2023 rbd 0.2 Remove redundant logging from PUT responders -# 31-May-2023 rbd 0.3 responder class names lower cased to match URI -# 08-Nov-2023 rbd 0.4 Replace exotic 'dunder' construction of error -# messages with actual text. Just a clarification. Remove -# superfluous () on class declarations. -# 15-Feb-2024 rbd 0.6 Upgrade to Rotator V4 (Platform 7) -# 16-Feb-2024 rbd 0.6 Passes Validtion and Protocol ConformU 2.1.0 -# 20-Feb-2024 rbd 0.7 Wow. Load device from Config (and toml) ha ha. -# Add setting for sync/async Connected write. -# 16-Sep-2024 rbd 1.0 Add logic for proper InvalidValueException on -# string to float conversions instead of just 400 errors. -# -import datetime, json -from falcon import Request, Response, HTTPBadRequest, before -from logging import Logger -from shr import PropertyResponse, MethodResponse, PreProcessRequest, \ - StateValue, get_request_field, to_bool -from exceptions import * # Nothing but exception classes -from rotatordevice import RotatorDevice - -logger: Logger = None # Really should use Pyton 3.10 or later -#logger = None # Safe on Python 3.7 but no intellisense in VSCode etc. - -# ---------------------- -# MULTI-INSTANCE SUPPORT -# ---------------------- -# If this is > 0 then it means that multiple devices of this type are supported. -# Each responder on_get() and on_put() is called with a devnum parameter to indicate -# which instance of the device (0-based) is being called by the client. Leave this -# set to 0 for the simple case of controlling only one instance of this device type. -# -maxdev = 0 # Single instance - -# ------------------- -# ROTATOR DEVICE INFO -# ------------------- -# Static metadata not subject to configuration changes -class RotatorMetadata: - """ Metadata describing the Rotator Device. Edit for your device""" - Name = 'Sample Rotator' - Version = '0.6' - Description = 'Sample ASCOM Rotator' - DeviceType = 'Rotator' - DeviceID = '1892ED30-92F3-4236-843E-DA8EEEF2D1CC' # https://guidgenerator.com/online-guid-generator.aspx - Info = 'Alpaca Sample Device\nImplements IRotatorV4\nASCOM Initiative' - MaxDeviceNumber = maxdev - InterfaceVersion = 4 # IRotatorV4 (Platform 7) - -# -------------------- -# SIMULATED ROTATOR () -# -------------------- -rot_dev = None -# At app init not import :-) -def start_rot_device(logger: logger): - logger = logger - global rot_dev - rot_dev = RotatorDevice(logger) - rot_dev.can_reverse = Config.can_reverse - rot_dev.step_size = Config.step_size - rot_dev.steps_per_sec = Config.steps_per_sec - rot_dev.sync_write_connected = Config.sync_write_connected - -# -------------------- -# RESOURCE CONTROLLERS -# -------------------- -@before(PreProcessRequest(maxdev)) -class action: - """Invoke the specified device-specific custom action - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.Action - """ - def on_put(self, req: Request, resp: Response, devnum: int): - name = get_request_field('ActionName', req) - params = get_request_field('ActionParameters', req) - # See SupportedActions - # Python 3.10 or newer - match name.lower(): - case 'myaction': - logger.info('MyAction called') - # Execute rot_dev.MyAction(params) - case 'youraction': - logger.info('YourAction called') - # Execute rot_dev.YourAction(params) - case _: - resp.text = MethodResponse(req, ActionNotImplementedException()) - # If you don't want to implement this at all then - # resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandblind: - # Do not use - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandbool: - # Do not use - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandstring: - # Do not use - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -# Connected, though common, is implemented in rotator.py -@before(PreProcessRequest(maxdev)) -class description: - """Description of the device such as manufacturer and model number. - Any ASCII characters may be used. - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.Description - """ - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(RotatorMetadata.Description, req).json - -@before(PreProcessRequest(maxdev)) -class driverinfo: - """Descriptive and version information about the ASCOM **driver** - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.DriverInfo - """ - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(RotatorMetadata.Info, req).json - -@before(PreProcessRequest(maxdev)) -class interfaceversion: - """ASCOM Device interface definition version that this device supports. - Should return 4 for this interface version IRotatorV4. - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.InterfaceVersion - """ - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(RotatorMetadata.InterfaceVersion, req).json - -@before(PreProcessRequest(maxdev)) -class driverversion: - """String containing only the major and minor version of the **driver**. - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.DriverVersion - """ - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(RotatorMetadata.Version, req).json - -@before(PreProcessRequest(maxdev)) -class name: - """The short name of the **driver**, for display purposes. - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.Name - """ - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(RotatorMetadata.Name, req).json - -@before(PreProcessRequest(maxdev)) -class supportedactions: - """Returns the list of custom action names, to be used with ``Action()``, - supported by this driver. - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.SupportedActions - """ - def on_get(self, req: Request, resp: Response, devnum: int): - val = [] - val.append('MyAction') - val.append('YourAction') - resp.text = PropertyResponse(val, req).json # Not PropertyNotImplemented - -@before(PreProcessRequest(maxdev)) -class canreverse: - """True if the rotator supports the ``Reverse`` method - - Seehttps://ascom-standards.org/newdocs/rotator.html#Rotator.CanReverse - - Always True for IRotatorV3 (InterfaceVersion >= 3). - """ - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(True, req).json # IRotatorV3, CanReverse must be True - -@before(PreProcessRequest(maxdev)) -class connect: - """Connect to the device asynchronously - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.Connect - """ - def on_put(self, req: Request, resp: Response, devnum: int): - try: - rot_dev.Connect() - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Rotator.Connect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connected: - """Retrieves or sets the connected state of the device - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.Connected - - Notes: - There is a setting ``sync_write_connected`` in config.toml that - determines whether connecting by writing ``Connected = True`` behaves - synchronously or acts asynchronously. Conform requires this to be synchronous - per IRotatorV3 (PLatform 6). - """ - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(rot_dev.connected, req).json - - def on_put(self, req: Request, resp: Response, devnum: int): - conn_str = get_request_field('Connected', req) - conn = to_bool(conn_str) # Raises 400 Bad Request if str to bool fails - - try: - # ---------------------- - rot_dev.connected = conn - # ---------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, # Put is actually like a method :-( - DriverException(0x500, 'Rotator.Connected failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connecting: - """True while the device is undertaking an asynchronous connect or disconnect operation. - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.Connecting - """ - def on_get(self, req: Request, resp: Response, devnum: int): - try: - val = rot_dev.connecting - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Rotator.Connecting failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class devicestate: - """List of StateValue objects representing the operational properties of this device. - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.DeviceState - """ - def on_get(self, req: Request, resp: Response, devnum: int): - if not rot_dev.connected: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - val = [] - val.append(StateValue('IsMoving', rot_dev.is_moving)) - val.append(StateValue('MechanicalPosition', rot_dev.mechanical_position)) - val.append(StateValue('Position', rot_dev.position)) - val.append(StateValue('TimeStamp', datetime.datetime.utcnow().isoformat())) - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Devicestate failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class disconnect: - """Disconnect from the device asynchronously. - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.Disconnect - - NOTE: In this sample, Disconnect is instantaneous - """ - def on_put(self, req: Request, resp: Response, devnum: int): - try: - rot_dev.Disconnect() - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Rotator.Disconnect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class ismoving: - """True if the rotator is currently moving to a new angle - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.IsMoving - """ - def on_get(self, req: Request, resp: Response, devnum: int): - if not rot_dev.connected: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # --------------------- - moving = rot_dev.is_moving - # --------------------- - resp.text = PropertyResponse(moving, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Rotator.IsMovingfailed', ex)).json - -@before(PreProcessRequest(maxdev)) -class mechanicalposition: - """The raw mechanical position of the rotator in degrees. - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.MechanicalPosition - """ - def on_get(self, req: Request, resp: Response, devnum: int): - if not rot_dev.connected: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # ------------------------------- - pos = rot_dev.mechanical_position - # ------------------------------- - resp.text = PropertyResponse(pos, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Rotator.MechanicalPosition failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class position: - """Current instantaneous Rotator position, allowing for any sync offset, in degrees. - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.Position - """ - def on_get(self, req: Request, resp: Response, devnum: int): - if not rot_dev.connected: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # ------------------------------- - pos = rot_dev.position - # ------------------------------- - resp.text = PropertyResponse(pos, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Rotator.Position failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class reverse: - """The direction of rotation CCW or CW - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.Reverse - """ - def on_get(self, req: Request, resp: Response, devnum: int): - if not rot_dev.connected: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # ------------------- - rev = rot_dev.reverse - # ------------------- - resp.text = PropertyResponse(rev, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Rotator.Reverse failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not rot_dev.connected: - resp.text = MethodResponse(req, - NotConnectedException()).json - return - revstr = get_request_field('Reverse', req) - try: - rev = to_bool(revstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Reverse {revstr} not a valid boolean.')).json - return - try: - # ---------------------- - rot_dev.reverse = rev - # ---------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, # Put is actually like a method :-( - DriverException(0x500, 'Rotator.Reverse failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class stepsize: - """Minimum rotation step size (deg) - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.StepSize - """ - def on_get(self, req: Request, resp: Response, devnum: int): - if not rot_dev.connected: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # --------------------- - steps = rot_dev.step_size - # --------------------- - resp.text = PropertyResponse(steps, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Rotator.StepSize failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class targetposition: - """The destination angle for ``Move()`` and ``MoveAbsolute()`` - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.TargetPosition - """ - def on_get(self, req: Request, resp: Response, devnum: int): - if not rot_dev.connected: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # --------------------------- - pos = rot_dev.target_position - # --------------------------- - resp.text = PropertyResponse(pos, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Rotator.TargetPosition failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class halt: - """Immediately stop any rotator motion - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.Halt - """ - def on_put(self, req: Request, resp: Response, devnum: int): - if not rot_dev.connected: - resp.text = MethodResponse(req, - NotConnectedException()).json - return - try: - # ------------ - rot_dev.Halt() - # ------------ - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Rotator.Halt failed', ex)).json - - -@before(PreProcessRequest(maxdev)) -class move: - """Start rotation relative to the current position (degrees) - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.Move - """ - def on_put(self, req: Request, resp: Response, devnum: int): - if not rot_dev.connected: - resp.text = MethodResponse(req, - NotConnectedException()).json - return - newpos_str = get_request_field('Position', req) # May raise 400 bad request - try: - newpos = origpos = float(newpos_str) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Position {newpos_str} not a valid float.')).json - return - # The spec calls for "anything goes" requires you to range the - # final value modulo 360 degrees. - if newpos >= 360.0: - newpos -= 360.0 - logger.debug('Result would be >= 360, setting to {newpos}') - if newpos < 0: - newpos += 360 - logger.debug('Result would be < 0, setting to {newpos}') - try: - # ------------------ - rot_dev.Move(newpos) # async - # ------------------ - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Rotator.Move failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class moveabsolute: - """Start rotation to the given ``Position`` (degrees) - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.MoveAbsolute - """ - def on_put(self, req: Request, resp: Response, devnum: int): - if not rot_dev.connected: - resp.text = MethodResponse(req, - NotConnectedException()).json - return - pos_str = get_request_field('Position', req) - try: - newpos = float(pos_str) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Position {pos_str} not a valid float.')).json - return - if newpos < 0.0 or newpos >= 360.0: - resp.text = MethodResponse(req, - InvalidValueException(f'Invalid position {str(newpos)} outside range 0 <= pos < 360.')).json - return - try: - # -------------------------- - rot_dev.MoveAbsolute(newpos) # async - # -------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Rotator.MoveAbsolute failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class movemechanical: - """Start rotation to the given new mechanical position (degrees) - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.MoveMechanical - """ - def on_put(self, req: Request, resp: Response, devnum: int): - formdata = req.get_media() - if not rot_dev.connected: - resp.text = MethodResponse(req, - NotConnectedException()).json - return - pos_str = get_request_field('Position', req) - try: - newpos = float(pos_str) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Position {pos_str} not a valid float.')).json - return - if newpos < 0.0 or newpos >= 360.0: - resp.text = MethodResponse(req, - InvalidValueException(f'Invalid position {str(newpos)} outside range 0 <= pos < 360.')).json - return - try: - # ---------------------------- - rot_dev.MoveMechanical(newpos) # async - # ---------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Rotator.MoveMechanical failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class sync: - """Syncs the rotator to the specified position angle (degrees) without moving it. - - See https://ascom-standards.org/newdocs/rotator.html#Rotator.Sync - """ - def on_put(self, req: Request, resp: Response, devnum: int): - formdata = req.get_media() - if not rot_dev.connected: - resp.text = MethodResponse(req, - NotConnectedException()).json - return - pos_str = get_request_field('Position', req) - try: - newpos = float(pos_str) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Position {pos_str} not a valid float.')).json - return - if newpos < 0.0 or newpos >= 360.0: - resp.text = MethodResponse(req, - InvalidValueException(f'Invalid position {str(newpos)} outside range 0 <= pos < 360.')).json - return - try: - # ------------------ - rot_dev.Sync(newpos) - # ------------------ - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Rotator.Sync failed', ex)).json diff --git a/device/rotatordevice.py b/device/rotatordevice.py deleted file mode 100644 index 56610e3..0000000 --- a/device/rotatordevice.py +++ /dev/null @@ -1,414 +0,0 @@ -# ================================================================= -# ROTATORDEVICE.PY - Poor-man's simulaton of a Rotator -# ================================================================= -# -# -*- coding: utf-8 -*- -# ----------------------------------------------------------------------------- -# rotatordevice.py - Poor-man's simulation of a rotator -# -# Part of the AlpycaDevice Alpaca skeleton/template device driver -# -# This is only for demo purposes. It's extremely fragile, and should -# not be used as an example of a real device. Settings not remembered. -# -# Author: Robert B. Denny (rbd) -# -# Python Compatibility: Requires Python 3.7 or later -# GitHub: https://github.com/ASCOMInitiative/AlpycaDevice -# -# ----------------------------------------------------------------------------- -# MIT License -# -# Copyright (c) 2022-2024 Bob Denny -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. -# ----------------------------------------------------------------------------- -# Edit History: -# 16-Dec-2022 rbd 0.1 Initial edit for Alpaca sample/template -# 18-Dec-2022 rbd 0.1 Type hints -# 19-Dec-2022 rbd 0.1 Add logic for IRotatorV3 offsets -# 24-Dec-2022 rbd 0.1 Logging -# 25-Dec-2022 rbd 0.1 Logging typing for intellisense -# 26-Dec-2022 rbd 0.1 Do not log within lock()ed sections -# 27-Dec-2022 rbd 0.1 MIT license and module header -# 15-Jan-2023 rbd 0.1 Documentation. No logic changes. -# 15-Feb-2024 rbd 0.6 Upgrade to Rotator V4 (Platform 7) -# 20-Feb-2024 rbd 0.7 Setting for Connected-Write to be sync or async -# -from threading import Timer -from threading import Lock -from logging import Logger - -class RotatorDevice: - """Simulated rotator device that does moves in separate Timer threads. - - Properties and methods generally follow the Alpaca interface. - Debug tracing here via (commented out) print() to avoid locking issues. - Hopefully you are familiar with Python threading and the need to lock - shared data items. - - **Mechanical vs Virtual Position** - - In this code 'mech' refers to the raw mechanical position. Note the - conversions ``_pos_to_mech()`` and ``_mech_to_pos()``. This is where - the ``Sync()`` offset is applied. - - """ - # - # Only override __init_() and run() (pydoc 17.1.2) - # - def __init__(self, logger: Logger): - self._lock = Lock() - self._connlock = Lock() - self.name: str = 'device' - self.logger = logger - # - # Rotator device constants - # - self._can_reverse: bool = True - self._step_size: float = 1.0 - self._steps_per_sec: int = 6 - self._conn_time_sec: float = 5.0 # Async connect delay - self._sync_write_connected = True; - # - # Rotator device state variables - # - self._reverse = False - self._mech_pos = 0.0 - self._tgt_mech_pos = 0.0 - self._pos_offset = 0.0 # TODO In real life this must be persisted - self._is_moving = False - self._connecting = False - self._connected = False - # - # Rotator engine - # - self._timer: Timer = None - self._interval: float = 1.0 / self._steps_per_sec - self._stopped: bool = True - # - # Connect delay - # - self._conntimer: Timer = None - - def _pos_to_mech(self, pos: float) -> float: - mech = pos - self._pos_offset - if mech >= 360.0: - mech -= 360.0 - if mech < 0.0: - mech += 360.0 - return mech - - def _mech_to_pos(self, mech: float) -> float: - pos = mech + self._pos_offset - if pos >= 360.0: - pos -= 360.0 - if pos < 0.0: - pos += 360.0 - return pos - - def _conn_complete(self): - self._connlock.acquire() - self.logger.info('[connected]') - self._connecting = False - self._connected = True - self._connlock.release() - - def start(self, from_run: bool = False) -> None: - #print('[start]') - self._lock.acquire() - #print('[start] got lock') - if from_run or self._stopped: - self._stopped = False - #print('[start] new timer') - self._timer = Timer(self._interval, self._run) - self._timer.name = 'Rotation step' - #print('[start] now start the timer') - self._timer.start() - #print('[start] timer started') - self._lock.release() - #print('[start] lock released') - else: - self._lock.release() - #print('[start] lock released') - - - def _run(self) -> None: - #print('[_run] (tmr expired) get lock') - self._lock.acquire() - #print(f'[_run] got lock : tgtmech={str(self._tgt_mech_pos)} mech={str(self._mech_pos)}') - delta = self._tgt_mech_pos - self._mech_pos - if delta < -180.0: - delta += 360.0 - if delta >= 180.0: - delta -= 360.0 - #print(f'[_run] final delta={str(delta)}') - if abs(delta) > (self._step_size / 2.0): - self._is_moving = True - if delta > 0: - #print('[_run] delta > 0 go positive') - self._mech_pos += self._step_size - if self._mech_pos >= 360.0: - self._mech_pos -= 360.0 - else: - #print('[_run] delta < 0 go negative') - self._mech_pos -= self._step_size - if self._mech_pos < 0.0: - self._mech_pos += 360.0 - #print(f'[_run] new pos = {str(self._mech_to_pos(self._mech_pos))}') - else: - self._is_moving = False - self._stopped = True - self._lock.release() - #print('[_run] lock released') - if self._is_moving: - #print('[_run] more motion needed, start another timer interval') - self.start(from_run = True) - - def stop(self) -> None: - self._lock.acquire() - #print('[stop] Stopping...') - self._stopped = True - self._is_moving = False - if self._timer is not None: - self._timer.cancel() - self._timer = None - self._lock.release() - - # - # Guarded properties - # - @property - def can_reverse(self) -> bool: - self._lock.acquire() - res = self._can_reverse - self._lock.release() - return res - @can_reverse.setter - def can_reverse (self, reverse: bool): - self._lock.acquire() - self._can_reverse = reverse - self._lock.release() - - @property - def reverse(self) -> bool: - self._lock.acquire() - res = self._reverse - self._lock.release() - return res - @reverse.setter - def reverse (self, reverse: bool): - self._lock.acquire() - self._reverse = reverse - self._lock.release() - - @property - def step_size(self) -> float: - self._lock.acquire() - res = self._step_size - self._lock.release() - return res - @step_size.setter - def step_size (self, step_size: float): - self._lock.acquire() - self._step_size = step_size - self._lock.release() - - @property - def steps_per_sec(self) -> int: - self._lock.acquire() - res = self._steps_per_sec - self._lock.release() - return res - @steps_per_sec.setter - def steps_per_sec (self, steps_per_sec: int): - self._lock.acquire() - self._steps_per_sec = steps_per_sec - self._lock.release() - - @property - def sync_write_connected(self) -> float: - self._lock.acquire() - res = self._sync_write_connected - self._lock.release() - return res - @sync_write_connected.setter - def sync_write_connected (self, sync: float): - self._lock.acquire() - self._sync_write_connected = sync - self._lock.release() - - @property - def position(self) -> float: - self._lock.acquire() - res = self._mech_to_pos(self._mech_pos) - self._lock.release() - self.logger.debug(f'[position] {str(res)}') - return res - - @property - def mechanical_position(self) -> float: - self._lock.acquire() - res = self._mech_pos - self._lock.release() - self.logger.debug(f'[mech position] {str(res)}') - return res - - @property - def target_position(self) -> float: - self._lock.acquire() - res = self._mech_to_pos(self._tgt_mech_pos) - self._lock.release() - self.logger.debug(f'[target_position] {str(res)}') - return res - - @property - def is_moving(self) -> bool: - self._lock.acquire() - res = self._is_moving - self.logger.debug(f'[is_moving] {str(res)}') - self._lock.release() - self.logger.debug(f'[is_moving] {str(res)}') - return res - - @property - def connected(self) -> bool: - self._connlock.acquire() - res = self._connected - self._connlock.release() - return res - @connected.setter - def connected (self, toconnect: bool): - self._connlock.acquire() - if (not toconnect) and self._connected and self._is_moving: - self._connlock.release() - # Yes you could call Halt() but this is for illustration - raise RuntimeError('Cannot disconnect while rotator is moving') - if toconnect: - if (self.sync_write_connected): - self._connected = True - self.logger.info('[instant connected]') - self._connlock.release() - else: - self._connlock.release() - self.logger.info('[delayed connecting]') - self.Connect() # Does own locking - else: - self._connected = False - self._connlock.release() - self.logger.info('[instant disconnected]') - - @property - def connecting(self) -> bool: - self._connlock.acquire() - res = self._connecting - self._connlock.release() - return res - - # ======= - # Methods - # ======= - - def Connect(self) -> None: - self.logger.debug(f'[Connect]') - self._connlock.acquire() - if self._connected: - self._connecting = False - self._connlock.release() - self.logger.debug(f'[Already connected]') - return - self._connecting = True - self._connected = False - self._connlock.release() - self._timer = Timer(self._conn_time_sec, self._conn_complete) - self._timer.name = 'Connect delay' - #print('[connect] now start the timer') - self._timer.start() - - def Disconnect(self) -> None: - self.logger.debug(f'[Disconnect]') - self._connlock.acquire() - if not self._connected: - self._connecting = False - self._connlock.release() - self.logger.debug(f'[Already disconnected]') - return - if self._is_moving: - self._connlock.release() - # Yes you could call Halt() but this is for illustration - raise RuntimeError('Cannot disconnect while rotator is moving') - self._connected = False - self._connlock.release() - - # TODO - This is supposed to throw if the final position is outside 0-360, but WHICH position? Mech or user???? - # - def Move(self, delta_pos: float) -> None: - self.logger.debug(f'[Move] pos={str(delta_pos)}') - self._lock.acquire() - if self._is_moving: - self._lock.release() - raise RuntimeError('Cannot start a move while the rotator is moving') - self._is_moving = True - self._tgt_mech_pos = self._mech_pos + delta_pos - self._pos_offset - if self._tgt_mech_pos >= 360.0: - self._tgt_mech_pos -= 360.0 - if self._tgt_mech_pos < 0.0: - self._tgt_mech_pos += 360.0 - self._lock.release() - self.logger.debug(f' targetpos={self._mech_to_pos(self._tgt_mech_pos)}') - self.start() - - def MoveAbsolute(self, pos: float) -> None: - self.logger.debug(f'[MoveAbs] pos={str(pos)}') - self._lock.acquire() - if self._is_moving: - self._lock.release() - raise RuntimeError('Cannot start a move while the rotator is moving') - self._is_moving = True - self._tgt_mech_pos = self._pos_to_mech(pos) - self._lock.release() - self.start() - - def MoveMechanical(self, pos: float) -> None: - self._lock.acquire() - if self._is_moving: - self._lock.release() - raise RuntimeError('Cannot start a move while the rotator is moving') - self.logger.debug(f'[MoveMech] pos={str(pos)}') - self._is_moving = True - self._tgt_mech_pos = pos - self._lock.release() - self.start() - - def Sync(self, pos: float) -> None: - self.logger.debug(f'[Sync] newpos={str(pos)}') - self._lock.acquire() - if self._is_moving: - self._lock.release() - raise RuntimeError('Cannot sync while rotator is moving') - self._pos_offset = pos - self._mech_pos - if self._pos_offset < -180.0: - self._pos_offset += 360.0 - if self._pos_offset >= 180.0: - self._pos_offset -= 360.0 - self._lock.release() - - def Halt(self) -> None: - self.logger.debug('[Halt]') - self.stop() diff --git a/docs/source/rotator.rst b/docs/source/rotator.rst deleted file mode 100644 index 31b5d56..0000000 --- a/docs/source/rotator.rst +++ /dev/null @@ -1,96 +0,0 @@ - -Rotator - Device-Specific Responders -==================================== - -This module contains the Rotator device-specific responder classes for the Alpaca -REST endpoints which represent ASCOM interface members. -You would need to create a module like this for the device you -wish to handle in your driver (e.g., ``Focuser``). The interface to each of -these responder classes is identical, as -described in |falcweb| but with the Alpaca Device Number as an additional -parameter to the ``on_get()`` and ``on_put()`` methods. - -The ASCOM standard interface members (properties and methods) are implemented -as separate responder classes here. Incoming Alpaca requests are mapped to -the responders. Thus, your device's low-level control code would be called -from within the ``on_get()`` and/or ``on_put()`` responder functions. Here -are the bare interfaces (*error handling omitted for clarity*). -See the :doc:`/roadmap` for details on how the responders work in this -template/sample. - -.. note:: - - * The ``devno`` parameter carries the Alpaca device number. This is used - only if your Alpaca device supports more than one ASCOM device (e.g. - two or more Rotators). - * The ``PropertyResponse`` and ``MethodResponse`` classes take a second attribute - for returning an Alpaca exception. If omitted, it defaults to Success - (no exception). - -**The maxdev = 1 Constant** - -This constant is passed as a parameter to all ``PreProcessRequest()`` decorators. -It is used to range check the device number in requests. It should be 1 unless -your Alpaca device supports more than one ASCOM device of this type (e.g. two -or more rotators). - -**Property (GET) Endpoint Responder** - -This returns a **Value** in the JSON response (``response.text``): - -.. code-block:: python - :emphasize-lines: 4 - :caption: Sample GET responder (for a property) - - @before(PreProcessRequest(maxdev)) - class IsMoving: - def on_get(self, req: Request, resp: Response, devnum: int): - value = #whatever your device says - resp.text = PropertyResponse(value, req).json - -**Method (PUT) Endpoint Responder** - -Initiates an action. Normally returns no value. Parameters for the method -are carried in the ``PUT`` request body, and are encoded as HTTP "form fields". -These are retrieved as a Python dictionary via the Falcon ``req.get_media()`` -function. - -.. code-block:: python - :emphasize-lines: 5 - :caption: Sample PUT responder (for a method) - - @before(PreProcessRequest(maxdev)) - class MoveAbsolute: - def on_put(self, req: Request, resp: Response, devnum: int): - formdata = req.get_media() - newpos = float(formdata['Position']) # Position parameter - # Whatever it takes to START the action - resp.text = MethodResponse(req).json - -API Responder Documentation ---------------------------- - -Each class is a responder for that specific member (property or method) of -the ASCOM IRotator specification. - -.. note:: - Calls to ``on_get()`` and ``on_put()`` have the same arguments as described - above and in |falcweb| plus the Alpaca DeviceNumber as the last - argument. - -.. attention:: - - The ``CommandXxx()`` methods are deprecated. These are left over from - the distant past. If you want to implement unique non-standard - commands for your device, use the ``Action()`` and ``SupportedActions`` - members. In this sample all of these are marked as not implemented. - -.. automodule:: rotator - :members: - - -.. |falcweb| raw:: html - - - The Falcon Web Framework - diff --git a/docs/source/rotatordevice.rst b/docs/source/rotatordevice.rst deleted file mode 100644 index d446d87..0000000 --- a/docs/source/rotatordevice.rst +++ /dev/null @@ -1,9 +0,0 @@ - -Simulated Rotator Device -======================== - -Read the source and do some debug tracing if you want to figure this out. -After all you're going to replace it with your own real device control logic, eh? - -.. automodule:: rotatordevice - :members: diff --git a/templates/.vscode/launch.json b/templates/.vscode/launch.json deleted file mode 100644 index e99e549..0000000 --- a/templates/.vscode/launch.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - // Use IntelliSense to learn about possible attributes. - // Hover to view descriptions of existing attributes. - // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 - "version": "0.2.0", - "configurations": [ - { - "name": "app", - "type": "python", - "request": "launch", - "program": "app.py", - "console": "integratedTerminal", - "justMyCode": true - }, - { - "name": "Python: Current File", - "type": "python", - "request": "launch", - "program": "${file}", - "console": "integratedTerminal", - "justMyCode": true - } - ] -} \ No newline at end of file diff --git a/templates/AlpacaDeviceAPI_v1.json b/templates/AlpacaDeviceAPI_v1.json deleted file mode 100644 index 274782b..0000000 --- a/templates/AlpacaDeviceAPI_v1.json +++ /dev/null @@ -1,32695 +0,0 @@ -{ - "openapi": "3.0.1", - "info": { - "title": "ASCOM Alpaca Simulators", - "description": "Please note that the Alpaca API documentation on the ASCOM website is the canonical version. There are several issues with this auto generated version that will be resolved in future versions. This is currently provided only for testing the simulators.", - "version": "v0" - }, - "paths": { - "/api/v1/camera/{DeviceNumber}/setccdtemperature": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current camera cooler setpoint in degrees Celsius.", - "description": "
Returns the current camera cooler setpoint in degrees Celsius.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Set the camera's cooler setpoint (degrees Celsius).", - "description": "
Set's the camera's cooler setpoint in degrees Celsius.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SetCCDTemperature" - ], - "type": "object", - "properties": { - "SetCCDTemperature": { - "type": "number", - "description": "Temperature set point(degrees Celsius).", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SetCCDTemperature": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/startx": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Return the current subframe X axis start position", - "description": "
Sets the subframe start position for the X axis (0 based) and returns the current value. If binning is active, value is in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the current subframe X axis start position", - "description": "
Sets the current subframe X axis start position in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "StartX" - ], - "type": "object", - "properties": { - "StartX": { - "type": "integer", - "description": "The subframe X axis start position in binned pixels.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "StartX": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/starty": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Return the current subframe Y axis start position", - "description": "
Sets the subframe start position for the Y axis (0 based) and returns the current value. If binning is active, value is in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the current subframe Y axis start position", - "description": "
Sets the current subframe Y axis start position in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "StartY" - ], - "type": "object", - "properties": { - "StartY": { - "type": "integer", - "description": "The subframe Y axis start position in binned pixels.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "StartY": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/subexposureduration": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Camera's sub-exposure interval", - "description": "
The Camera's sub exposure duration in seconds. Only available in Camera Interface Version 3 and later.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the current Sub Exposure Duration", - "description": "
Sets image sub exposure duration in seconds. Only available in Camera Interface Version 3 and later.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SubExposureDuration" - ], - "type": "object", - "properties": { - "SubExposureDuration": { - "type": "number", - "description": "The request sub exposure duration in seconds", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SubExposureDuration": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/abortexposure": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Aborts the current exposure", - "description": "
Aborts the current exposure, if any, and returns the camera to Idle state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/pulseguide": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Aborts the current exposure", - "description": "
Aborts the current exposure, if any, and returns the camera to Idle state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Direction", - "Duration" - ], - "type": "object", - "properties": { - "Direction": { - "$ref": "#/components/schemas/GuideDirection" - }, - "Duration": { - "type": "integer", - "description": "Duration of movement in milli-seconds", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Direction": { - "style": "form" - }, - "Duration": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/startexposure": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Starts an exposure", - "description": "
Starts an exposure. Use ImageReady to check when the exposure is complete.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Duration", - "Light" - ], - "type": "object", - "properties": { - "Duration": { - "type": "number", - "description": "Duration of exposure in seconds", - "format": "double" - }, - "Light": { - "type": "boolean", - "description": "True if light frame, false if dark frame." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Duration": { - "style": "form" - }, - "Light": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/stopexposure": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Stops the current exposure", - "description": "
Stops the current exposure, if any. If an exposure is in progress, the readout process is initiated. Ignored if readout is already in process.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/bayeroffsetx": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the X offset of the Bayer matrix.", - "description": "
Returns the X offset of the Bayer matrix, as defined in SensorType.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/bayeroffsety": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the Y offset of the Bayer matrix.", - "description": "
Returns the Y offset of the Bayer matrix, as defined in SensorType.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/binx": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the binning factor for the X axis.", - "description": "
Returns the binning factor for the X axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the binning factor for the X axis.", - "description": "
Sets the binning factor for the X axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "BinX" - ], - "type": "object", - "properties": { - "BinX": { - "type": "integer", - "description": "The X binning value", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "BinX": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/biny": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the binning factor for the Y axis.", - "description": "
Returns the binning factor for the Y axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the binning factor for the Y axis.", - "description": "
Sets the binning factor for the Y axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "BinY" - ], - "type": "object", - "properties": { - "BinY": { - "type": "integer", - "description": "The Y binning value", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "BinY": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/camerastate": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the camera operational state.", - "description": "
Returns the current camera operational state as an integer. 0 = CameraIdle , 1 = CameraWaiting , 2 = CameraExposing , 3 = CameraReading , 4 = CameraDownload , 5 = CameraError", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/cameraxsize": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the width of the CCD camera chip.", - "description": "
Returns the width of the CCD camera chip in unbinned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/cameraysize": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the height of the CCD camera chip.", - "description": "
Returns the height of the CCD camera chip in unbinned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/canabortexposure": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates whether the camera can abort exposures.", - "description": "
Returns true if the camera can abort exposures; false if not.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/canasymmetricbin": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates whether the camera supports asymmetric binning", - "description": "
Returns a flag showing whether this camera supports asymmetric binning", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/canfastreadout": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates whether the camera has a fast readout mode.", - "description": "
Indicates whether the camera has a fast readout mode.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/cangetcoolerpower": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates whether the camera's cooler power setting can be read.", - "description": "
If true, the camera's cooler power setting can be read.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/canpulseguide": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns a flag indicating whether this camera supports pulse guiding", - "description": "
Returns a flag indicating whether this camera supports pulse guiding.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/cansetccdtemperature": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns a flag indicating whether this camera supports setting the CCD temperature", - "description": "
Returns a flag indicatig whether this camera supports setting the CCD temperature", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/canstopexposure": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns a flag indicating whether this camera can stop an exposure that is in progress", - "description": "
Returns a flag indicating whether this camera can stop an exposure that is in progress", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/ccdtemperature": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current CCD temperature", - "description": "
Returns the current CCD temperature in degrees Celsius.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/cooleron": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current cooler on/off state.", - "description": "
Returns the current cooler on/off state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Turns the camera cooler on and off", - "description": "
Turns on and off the camera cooler. True = cooler on, False = cooler off", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "CoolerOn" - ], - "type": "object", - "properties": { - "CoolerOn": { - "type": "boolean", - "description": "Cooler state" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "CoolerOn": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/coolerpower": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the present cooler power level", - "description": "
Returns the present cooler power level, in percent.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/electronsperadu": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the gain of the camera", - "description": "
Returns the gain of the camera in photoelectrons per A/D unit.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/exposuremax": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the maximum exposure time supported by StartExposure.", - "description": "
Returns the maximum exposure time supported by StartExposure.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/exposuremin": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the Minimum exposure time", - "description": "
Returns the Minimum exposure time in seconds that the camera supports through StartExposure.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/exposureresolution": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the smallest increment in exposure time supported by StartExposure.", - "description": "
Returns the smallest increment in exposure time supported by StartExposure.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/fastreadout": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns whether Fast Readout Mode is enabled.", - "description": "
Returns whether Fast Readout Mode is enabled", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets whether Fast Readout Mode is enabled.", - "description": "
Sets whether Fast Readout Mode is enabled.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "FastReadout" - ], - "type": "object", - "properties": { - "FastReadout": { - "type": "boolean", - "description": "True to enable fast readout mode" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "FastReadout": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/fullwellcapacity": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Reports the full well capacity of the camera", - "description": "
Reports the full well capacity of the camera in electrons, at the current camera settings (binning, SetupDialog settings, etc.).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/gain": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the camera's gain", - "description": "
The camera's gain (GAIN VALUE MODE) OR the index of the selected camera gain description in the Gains array (GAINS INDEX MODE).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the camera's gain.", - "description": "
The camera's gain (GAIN VALUE MODE) OR the index of the selected camera gain description in the Gains array (GAINS INDEX MODE).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Gain" - ], - "type": "object", - "properties": { - "Gain": { - "type": "integer", - "description": "Index of the current camera gain in the Gains string array.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Gain": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/gainmax": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Maximum Gain value of that this camera supports", - "description": "
Returns the maximum value of Gain.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/gainmin": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Minimum Gain value of that this camera supports", - "description": "
Returns the Minimum value of Gain", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/gains": { - "get": { - "tags": [ - "Camera" - ], - "summary": "List of Gain names supported by the camera", - "description": "
Returns the Gains supported by the camera.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/hasshutter": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates whether the camera has a mechanical shutter", - "description": "
Returns a flag indicating whether this camera has a mechanical shutter.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/heatsinktemperature": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current heat sink temperature.", - "description": "
Returns the current heat sink temperature (called \"ambient temperature\" by some manufacturers) in degrees Celsius.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/imagearray": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns an array (2d or 3d of integers) containing the exposure pixel values", - "description": "
\r\n Returns an array containing the pixel values from the last exposure.\r\n This call can return either a 2 dimension (monochrome images) or 3 dimension (colour or multi-plane images) array of size NumX * NumY or NumX * NumY * NumPlanes.\r\n Where applicable, the size of NumPlanes has to be determined by inspection of the returned Array.\r\n \r\n
\r\n Since 32bit integers are always returned by this call, the returned JSON Type value (0 = Unknown, 1 = short(16bit), 2 = int(32bit), 3 = Double) is always 2. The number of planes is given in the returned Rank value.\r\n \r\n
\r\n When de-serialising to an object it helps enormously to know the array Rank beforehand so that the correct data class can be used. This can be achieved through a regular expression or by direct parsing of the returned JSON string to extract the Type and Rank values before de-serialising.\r\n \r\n
\r\n This regular expression accomplishes the extraction into two named groups Type and Rank, which can then be used to select the correct de-serialisation data class:\r\n \r\n
\r\n ^*\"Type\":(?\\d*),\"Rank\":(?\\d*)\r\n \r\n
\r\n When the SensorType is Monochrome, RGGB, CMYG, CMYG2 or LRGB, the serialised JSON array should have 2 dimensions. For example, the returned array should appear as below if NumX = 7, NumY = 5 and Pxy represents the pixel value at the zero based position x across and y down the image with the origin in the top left corner of the image. Please note that this is \"column-major\" order.\r\n \r\n
\r\n [\r\n [P00, P01, P02, P03, P04],\r\n [P10, P11, P12, P13, P14],\r\n [P20, P21, P22, P23, P24],\r\n [P30, P31, P32, P33, P34],\r\n [P40, P41, P42, P43, P44],\r\n [P50, P51, P52, P53, P54],\r\n [P60, P61, P62, P63, P64]\r\n ]\r\n \r\n
\r\n When the SensorType is Color, the serialised JSON array should have 3 dimensions.For example, the returned array should appear as below if NumX = 7, NumY = 5 and Rxy, Gxy and Bxy represent the red, green and blue pixel values at the zero based position x across and y down the image with the origin in the top left corner of the image.Please note that this is \"column-major\" order.\r\n \r\n
\r\n [\r\n [[R00, G00, B00],[R01, G01, B01],[R02, G02, B02],[R03, G03, B03],[R04, G04, B04]],\r\n [[R10, G10, B10],[R11, G11, B11],[R12, G12, B12],[R13, G13, B13],[R14, G14, B14]],\r\n [[R20, G20, B20],[R21, G21, B21],[R22, G22, B22],[R23, G23, B23],[R24, G24, B24]],\r\n [[R30, G30, B30],[R31, G31, B31],[R32, G32, B32],[R33, G33, B33],[R34, G34, B34]],\r\n [[R40, G40, B40],[R41, G41, B41],[R42, G42, B42],[R43, G43, B43],[R44, G44, B44]],\r\n [[R50, G50, B50],[R51, G51, B51],[R52, G52, B52],[R53, G53, B53],[R54, G54, B54]],\r\n [[R60, G60, B60],[R61, G61, B61],[R62, G62, B62],[R63, G63, B63],[R64, G64, B64]],\r\n ]\r\n ", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntArray2DResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/imagearrayvariant": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns an array containing the exposure pixel values", - "description": "
\r\n Returns an array containing the pixel values from the last exposure.\r\n This call can return either a 2 dimension (monochrome images) or 3 dimension (colour or multi-plane images) array of size NumX * NumY or NumX * NumY * NumPlanes.\r\n Where applicable, the size of NumPlanes has to be determined by inspection of the returned Array.\r\n \r\n
\r\n This call can return values as short(16bit) integers, int(32bit) integers or double floating point values. The nature of the returned values is given in the Type parameter: 0 = Unknown, 1 = short(16bit), 2 = int(32bit), 3 = Double. The number of planes is given in the returned Rank value.\r\n \r\n
\r\n When de-serialising to an object it helps enormously to know the array Rank beforehand so that the correct data class can be used. This can be achieved through a regular expression or by direct parsing of the returned JSON string to extract the Type and Rank values before de-serialising.\r\n \r\n
\r\n This regular expression accomplishes the extraction into two named groups Type and Rank, which can then be used to select the correct de-serialisation data class:\r\n \r\n
\r\n ^*\"Type\":(?\\d*),\"Rank\":(?\\d*)\r\n \r\n
\r\n When the SensorType is Monochrome, RGGB, CMYG, CMYG2 or LRGB, the serialised JSON array should have 2 dimensions. For example, the returned array should appear as below if NumX = 7, NumY = 5 and Pxy represents the pixel value at the zero based position x across and y down the image with the origin in the top left corner of the image. Please note that this is \"column-major\" order.\r\n \r\n
\r\n [\r\n [P00, P01, P02, P03, P04],\r\n [P10, P11, P12, P13, P14],\r\n [P20, P21, P22, P23, P24],\r\n [P30, P31, P32, P33, P34],\r\n [P40, P41, P42, P43, P44],\r\n [P50, P51, P52, P53, P54],\r\n [P60, P61, P62, P63, P64]\r\n ]\r\n \r\n
\r\n When the SensorType is Color, the serialised JSON array should have 3 dimensions.For example, the returned array should appear as below if NumX = 7, NumY = 5 and Rxy, Gxy and Bxy represent the red, green and blue pixel values at the zero based position x across and y down the image with the origin in the top left corner of the image.Please note that this is \"column-major\" order.\r\n \r\n
\r\n [\r\n [[R00, G00, B00],[R01, G01, B01],[R02, G02, B02],[R03, G03, B03],[R04, G04, B04]],\r\n [[R10, G10, B10],[R11, G11, B11],[R12, G12, B12],[R13, G13, B13],[R14, G14, B14]],\r\n [[R20, G20, B20],[R21, G21, B21],[R22, G22, B22],[R23, G23, B23],[R24, G24, B24]],\r\n [[R30, G30, B30],[R31, G31, B31],[R32, G32, B32],[R33, G33, B33],[R34, G34, B34]],\r\n [[R40, G40, B40],[R41, G41, B41],[R42, G42, B42],[R43, G43, B43],[R44, G44, B44]],\r\n [[R50, G50, B50],[R51, G51, B51],[R52, G52, B52],[R53, G53, B53],[R54, G54, B54]],\r\n [[R60, G60, B60],[R61, G61, B61],[R62, G62, B62],[R63, G63, B63],[R64, G64, B64]],\r\n ]\r\n ", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntArray2DResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/imageready": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates that an image is ready to be downloaded", - "description": "
Returns a flag indicating whether the image is ready to be downloaded from the camera.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/ispulseguiding": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates that the camera is pulse guiding.", - "description": "
Returns a flag indicating whether the camera is currently in a PulseGuide operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/lastexposureduration": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Duration of the last exposure", - "description": "
Reports the actual exposure duration in seconds (i.e. shutter open time).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/lastexposurestarttime": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Start time of the last exposure in FITS standard format.", - "description": "
Reports the actual exposure start in the FITS-standard CCYY-MM-DDThh:mm:ss[.sss...] format.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/maxadu": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Camera's maximum ADU value", - "description": "
Reports the maximum ADU value the camera can produce.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/maxbinx": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Maximum binning for the camera X axis", - "description": "
Returns the maximum allowed binning for the X camera axis", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/maxbiny": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Maximum binning for the camera Y axis", - "description": "
Returns the maximum allowed binning for the Y camera axis", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/numx": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current subframe width", - "description": "
Returns the current subframe width, if binning is active, value is in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the current subframe width", - "description": "
Sets the current subframe width.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "NumX" - ], - "type": "object", - "properties": { - "NumX": { - "type": "integer", - "description": "Sets the subframe width, if binning is active, value is in binned pixels.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "NumX": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/numy": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current subframe height", - "description": "
Returns the current subframe height, if binning is active, value is in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the current subframe height", - "description": "
Sets the current subframe height.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "NumY" - ], - "type": "object", - "properties": { - "NumY": { - "type": "integer", - "description": "Sets the subframe height, if binning is active, value is in binned pixels.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "NumY": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/offset": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the camera's offset", - "description": "
Returns the camera's offset (OFFSET VALUE MODE) OR the index of the selected camera offset description in the offsets array (OFFSETS INDEX MODE).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the camera's offset.", - "description": "
Sets the camera's offset (OFFSET VALUE MODE) OR the index of the selected camera offset description in the offsets array (OFFSETS INDEX MODE).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Offset" - ], - "type": "object", - "properties": { - "Offset": { - "type": "integer", - "description": "Index of the current camera offset in the offsets string array.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Offset": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/offsetmax": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Maximum offset value of that this camera supports", - "description": "
Returns the maximum value of offset.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/offsetmin": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Minimum offset value of that this camera supports", - "description": "
Returns the Minimum value of offset.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/offsets": { - "get": { - "tags": [ - "Camera" - ], - "summary": "List of offset names supported by the camera", - "description": "
Returns the offsets supported by the camera.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/percentcompleted": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates percentage completeness of the current operation", - "description": "
Returns the percentage of the current operation that is complete. If valid, returns an integer between 0 and 100, where 0 indicates 0% progress (function just started) and 100 indicates 100% progress (i.e. completion).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/pixelsizex": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Width of CCD chip pixels (microns)", - "description": "
Returns the width of the CCD chip pixels in microns.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/pixelsizey": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Height of CCD chip pixels (microns)", - "description": "
Returns the Height of the CCD chip pixels in microns.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/readoutmode": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates the camera's readout mode as an index into the array ReadoutModes", - "description": "
ReadoutMode is an index into the array ReadoutModes and returns the desired readout mode for the camera. Defaults to 0 if not set.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Set the camera's readout mode", - "description": "
Sets the ReadoutMode as an index into the array ReadoutModes.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "ReadoutMode" - ], - "type": "object", - "properties": { - "ReadoutMode": { - "type": "integer", - "description": "Index into the ReadoutModes array of string readout mode names indicating the camera's current readout mode.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ReadoutMode": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/readoutmodes": { - "get": { - "tags": [ - "Camera" - ], - "summary": "List of available readout modes", - "description": "
This property provides an array of strings, each of which describes an available readout mode of the camera. At least one string must be present in the list.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/sensorname": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Sensor name", - "description": "
The name of the sensor used within the camera.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/sensortype": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Type of information returned by the the camera sensor (monochrome or colour)", - "description": "
Returns a value indicating whether the sensor is monochrome, or what Bayer matrix it encodes. Where:\r\n
0 = Monochrome,\r\n
1 = Colour not requiring Bayer decoding\r\n
2 = RGGB Bayer encoding\r\n
3 = CMYG Bayer encoding\r\n
4 = CMYG2 Bayer encoding\r\n
5 = LRGB TRUESENSE Bayer encoding.\r\n
Please see the ASCOM Help fie for more information on the SensorType.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/action": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/description": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Camera" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/name": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/brightness": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the current calibrator brightness", - "description": "
Returns the current calibrator brightness in the range 0 (completely off) to MaxBrightness (fully on)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/calibratorstate": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the state of the calibration device", - "description": "
Returns the state of the calibration device, if present, otherwise returns \"NotPresent\". The calibrator state mode is specified as an integer value from the CalibratorStatus Enum.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/coverstate": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the state of the device cover", - "description": "
Returns the state of the device cover, if present, otherwise returns \"NotPresent\". The cover state mode is specified as an integer value from the CoverStatus Enum.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/maxbrightness": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the calibrator's maximum Brightness value.", - "description": "
The Brightness value that makes the calibrator deliver its maximum illumination.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/calibratoroff": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Turns the calibrator off", - "description": "
Turns the calibrator off if the device has calibration capability.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/calibratoron": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Turns the calibrator on at the specified brightness", - "description": "
Turns the calibrator on at the specified brightness if the device has calibration capability.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Brightness" - ], - "type": "object", - "properties": { - "Brightness": { - "type": "integer", - "description": "The required brightness in the range 0 to MaxBrightness", - "format": "int32", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Brightness": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/closecover": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Initiates cover closing", - "description": "
Initiates cover closing if a cover is present.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/haltcover": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Stops any cover movement that may be in progress", - "description": "
Stops any cover movement that may be in progress if a cover is present and cover movement can be interrupted.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/opencover": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Initiates cover opening", - "description": "
Initiates cover opening if a cover is present.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/action": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/connected": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/description": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/name": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/altitude": { - "get": { - "tags": [ - "Dome" - ], - "summary": "The dome altitude", - "description": "
The dome altitude (degrees, horizon zero and increasing positive to 90 zenith).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/athome": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome is in the home position.", - "description": "
Indicates whether the dome is in the home position.\r\n This is normally used following a FindHome() operation.\r\n The value is reset with any azimuth slew operation that moves the dome away from the home position.\r\n AtHome may also become true during normal slew operations,\r\n if the dome passes through the home position and the dome controller hardware is capable of detecting that;\r\n or at the end of a slew operation if the dome comes to rest at the home position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/atpark": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome is at the park position", - "description": "
True if the dome is in the programmed park position. Set only following a Park() operation and reset with any slew operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/azimuth": { - "get": { - "tags": [ - "Dome" - ], - "summary": "The dome azimuth", - "description": "
Returns the dome azimuth (degrees, North zero and increasing clockwise, i.e., 90 East, 180 South, 270 West)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/canfindhome": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome can find the home position.", - "description": "
True if the dome can move to the home position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/canpark": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome can be parked.", - "description": "
True if the dome is capable of programmed parking (Park() method)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/cansetaltitude": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome altitude can be set", - "description": "
True if driver is capable of setting the dome altitude.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/cansetazimuth": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome azimuth can be set", - "description": "
True if driver is capable of setting the dome azimuth.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/cansetpark": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome park position can be set", - "description": "
True if driver is capable of setting the dome park position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/cansetshutter": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome shutter can be opened", - "description": "
True if driver is capable of automatically operating shutter", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/canslave": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome supports slaving to a telescope", - "description": "
True if driver is capable of slaving to a telescope.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/cansyncazimuth": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome azimuth position can be synced", - "description": "
True if driver is capable of synchronizing the dome azimuth position using the SyncToAzimuth(Double) method.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/shutterstatus": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Status of the dome shutter or roll-off roof", - "description": "
Returns the status of the dome shutter or roll-off roof. 0 = Open, 1 = Closed, 2 = Opening, 3 = Closing, 4 = Shutter status error", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/slaved": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome is slaved to the telescope", - "description": "
True if the dome is slaved to the telescope in its hardware, else False.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Dome" - ], - "summary": "Sets whether the dome is slaved to the telescope", - "description": "
Sets whether the dome is slaved to the telescope", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Slaved" - ], - "type": "object", - "properties": { - "Slaved": { - "type": "boolean", - "description": "True if telescope is slaved to dome, otherwise false" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Slaved": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/slewing": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the any part of the dome is moving", - "description": "
True if any part of the dome is currently moving, False if all dome components are steady.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/abortslew": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Immediately cancel current dome operation.", - "description": "
Calling this method will immediately disable hardware slewing (Slaved will become False).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/closeshutter": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Close the shutter or otherwise shield telescope from the sky.", - "description": "
Close the shutter or otherwise shield telescope from the sky.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/findhome": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Start operation to search for the dome home position.", - "description": "
After Home position is established initializes Azimuth to the default value and sets the AtHome flag.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/openshutter": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Open shutter or otherwise expose telescope to the sky.", - "description": "
Open shutter or otherwise expose telescope to the sky.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/park": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Rotate dome in azimuth to park position.", - "description": "
After assuming programmed park position, sets AtPark flag.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/setpark": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Set the current azimuth, altitude position of dome to be the park position.", - "description": "
Set the current azimuth, altitude position of dome to be the park position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/slewtoaltitude": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Slew the dome to the given altitude position.", - "description": "
Slew the dome to the given altitude position", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Altitude" - ], - "type": "object", - "properties": { - "Altitude": { - "type": "number", - "description": "Target dome altitude (degrees, horizon zero and increasing positive to 90 zenith0", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Altitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/slewtoazimuth": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Slew the dome to the given azimuth position.", - "description": "
Slew the dome to the given azimuth position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Azimuth" - ], - "type": "object", - "properties": { - "Azimuth": { - "type": "number", - "description": "Target dome azimuth (degrees, North zero and increasing clockwise. i.e., 90 East, 180 South, 270 West)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Azimuth": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/synctoazimuth": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Synchronize the dome to the given azimuth position.", - "description": "
Synchronize the dome to the given azimuth position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Azimuth" - ], - "type": "object", - "properties": { - "Azimuth": { - "type": "number", - "description": "Target dome azimuth (degrees, North zero and increasing clockwise. i.e., 90 East, 180 South, 270 West)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Azimuth": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/action": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Dome" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/description": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Dome" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/name": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/focusoffsets": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Filter focus offsets", - "description": "
An integer array of filter focus offsets.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/names": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Filter wheel filter names", - "description": "
The names of the filters", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/position": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Returns the current filter wheel position", - "description": "
Returns the current filter wheel position", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Sets the filter wheel position", - "description": "
Sets the filter wheel position", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "integer", - "description": "Sets the filter wheel position", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/action": { - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/connected": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/description": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/name": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/absolute": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Indicates whether the focuser is capable of absolute position.", - "description": "
True if the focuser is capable of absolute position; that is, being commanded to a specific step location.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/ismoving": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Indicates whether the focuser is currently moving.", - "description": "
True if the focuser is currently moving to a new position. False if the focuser is stationary.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/maxincrement": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the focuser's maximum increment size.", - "description": "
Maximum increment size allowed by the focuser; i.e. the maximum number of steps allowed in one move operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/maxstep": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the focuser's maximum step size.", - "description": "
Maximum step position permitted.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/position": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the focuser's current position.", - "description": "
Current focuser position, in steps.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/stepsize": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the focuser's step size.", - "description": "
Step size (microns) for the focuser.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/tempcomp": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Retrieves the state of temperature compensation mode", - "description": "
Gets the state of temperature compensation mode (if available), else always False.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Focuser" - ], - "summary": "Sets the device's temperature compensation mode.", - "description": "
Sets the state of temperature compensation mode.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "TempComp" - ], - "type": "object", - "properties": { - "TempComp": { - "type": "boolean", - "description": "Set true to enable the focuser's temperature compensation mode, otherwise false for normal operation." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "TempComp": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/tempcompavailable": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Indicates whether the focuser has temperature compensation.", - "description": "
True if focuser has temperature compensation available.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/temperature": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the focuser's current temperature.", - "description": "
Current ambient temperature as measured by the focuser.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/halt": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Immediately stops focuser motion.", - "description": "
Immediately stop any focuser motion due to a previous Move(Int32) method call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/move": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Moves the focuser to a new position.", - "description": "
Moves the focuser by the specified amount or to the specified position depending on the value of the Absolute property.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "integer", - "description": "Step distance or absolute position, depending on the value of the Absolute property", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/action": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Focuser" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/description": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/name": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/management/apiversions": { - "get": { - "tags": [ - "Management" - ], - "summary": "Supported Alpaca API versions", - "description": "
Returns an integer array of supported Alpaca API version numbers.", - "parameters": [ - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/management/v1/description": { - "get": { - "tags": [ - "Management" - ], - "summary": "Summary information about this device as a whole", - "description": "
Summary information about each available ASCOM device", - "parameters": [ - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AlpacaDescriptionResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/management/v1/configureddevices": { - "get": { - "tags": [ - "Management" - ], - "summary": "Summary information about each available ASCOM device", - "description": "
Returns an array of device description objects, providing unique information for each served device, enabling them to be accessed through the Alpaca Device API.", - "parameters": [ - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AlpacaConfiguredDevicesResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/averageperiod": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the time period over which observations will be averaged", - "description": "
Gets the time period over which observations will be averaged", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Sets the time period over which observations will be averaged", - "description": "
Sets the time period over which observations will be averaged", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "AveragePeriod" - ], - "type": "object", - "properties": { - "AveragePeriod": { - "type": "number", - "description": "Time period(hours) over which to average sensor readings", - "format": "double", - "default": 1 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "AveragePeriod": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/cloudcover": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the amount of sky obscured by cloud", - "description": "
Gets the percentage of the sky obscured by cloud", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/dewpoint": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the atmospheric dew point at the observatory", - "description": "
Gets the atmospheric dew point at the observatory reported in °C.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/humidity": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the atmospheric humidity at the observatory", - "description": "
Gets the atmospheric humidity (%) at the observatory", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/pressure": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the atmospheric pressure at the observatory.", - "description": "
Gets the atmospheric pressure in hectoPascals at the observatory's altitude - NOT reduced to sea level.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/rainrate": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the rain rate at the observatory.", - "description": "
Gets the rain rate (mm/hour) at the observatory.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/skybrightness": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the sky brightness at the observatory", - "description": "
Gets the sky brightness at the observatory (Lux)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/skyquality": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the sky quality at the observatory", - "description": "
Gets the sky quality at the observatory (magnitudes per square arc second)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/skytemperature": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the sky temperature at the observatory", - "description": "
Gets the sky temperature(°C) at the observatory.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/starfwhm": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the seeing at the observatory", - "description": "
Gets the seeing at the observatory measured as star full width half maximum (FWHM) in arc secs.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/temperature": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the temperature at the observatory", - "description": "
Gets the temperature(°C) at the observatory.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/winddirection": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the wind direction at the observatory", - "description": "
Gets the wind direction. The returned value must be between 0.0 and 360.0, interpreted according to the metereological standard, where a special value of 0.0 is returned when the wind speed is 0.0. Wind direction is measured clockwise from north, through east, where East=90.0, South=180.0, West=270.0 and North=360.0.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/windgust": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the peak 3 second wind gust at the observatory over the last 2 minutes", - "description": "
Gets the peak 3 second wind gust(m/s) at the observatory over the last 2 minutes.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/windspeed": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the wind speed at the observatory.", - "description": "
Gets the wind speed(m/s) at the observatory.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/refresh": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Refreshes sensor values from hardware.", - "description": "
Forces the driver to immediately query its attached hardware to refresh sensor values.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/sensordescription": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Return a sensor description", - "description": "
Gets a description of the sensor with the name specified in the SensorName parameter", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "SensorName", - "in": "query", - "description": "Name of the sensor whose description is required", - "required": true, - "schema": { - "type": "string", - "description": "Name of the sensor whose description is required" - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/timesincelastupdate": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Return the time since the sensor value was last updated", - "description": "
Gets the time since the sensor specified in the SensorName parameter was last updated", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "SensorName", - "in": "query", - "description": "Name of the sensor whose description is required", - "schema": { - "type": "string" - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/action": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/connected": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/description": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/name": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/canreverse": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Indicates whether the Rotator supports the Reverse method.", - "description": "
True if the Rotator supports the Reverse method.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/ismoving": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Indicates whether the rotator is currently moving.", - "description": "
True if the rotator is currently moving to a new position. False if the focuser is stationary.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/mechanicalposition": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the rotator’s Reverse state.", - "description": "
Returns the rotator’s Reverse state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/position": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the rotator's current position.", - "description": "
Current instantaneous Rotator position, in degrees.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/reverse": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the rotator’s Reverse state.", - "description": "
Returns the rotator’s Reverse state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Rotator" - ], - "summary": "Sets the rotator’s Reverse state.", - "description": "
Sets the rotator’s Reverse state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Reverse" - ], - "type": "object", - "properties": { - "Reverse": { - "type": "boolean", - "description": "True if the rotation and angular direction must be reversed to match the optical characteristcs" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Reverse": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/stepsize": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the minimum StepSize", - "description": "
The minimum StepSize, in degrees.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/targetposition": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the destination position angle.", - "description": "
The destination position angle for Move() and MoveAbsolute().", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/halt": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Immediately stops rotator motion.", - "description": "
Immediately stop any Rotator motion due to a previous Move or MoveAbsolute method call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/move": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Moves the rotator to a new relative position.", - "description": "
Causes the rotator to move Position degrees relative to the current Position value.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "number", - "description": "Relative position to move in degrees from current Position.", - "format": "double", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/moveabsolute": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Moves the rotator to a new absolute position.", - "description": "
Causes the rotator to move the absolute position of Position degrees.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "number", - "description": "Absolute position in degrees.", - "format": "double", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/movemechanical": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Moves the rotator to a new raw mechanical position.", - "description": "
Causes the rotator to move the mechanical position of Position degrees.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "number", - "description": "Absolute position in degrees.", - "format": "double", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/sync": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Syncs the rotator to the specified position angle without moving it.", - "description": "
Causes the rotator to sync to the position of Position degrees.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "number", - "description": "Absolute position in degrees.", - "format": "double", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/action": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Rotator" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/description": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/name": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/issafe": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Indicates whether the monitored state is safe for use.", - "description": "
Indicates whether the monitored state is safe for use. True if the state is safe, False if it is unsafe.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/action": { - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/connected": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/description": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/name": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/camera/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/covercalibrator/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/dome/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/filterwheel/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/focuser/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/observingconditions/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/rotator/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/safetymonitor/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/switch/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/telescope/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/camera/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/covercalibrator/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/dome/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/filterwheel/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/focuser/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/observingconditions/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/rotator/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/safetymonitor/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/switch/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/telescope/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/camera/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/covercalibrator/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/dome/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/filterwheel/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/focuser/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/observingconditions/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/rotator/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/safetymonitor/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/switch/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/telescope/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/maxswitch": { - "get": { - "tags": [ - "Switch" - ], - "summary": "The number of switch devices managed by this driver", - "description": "
Returns the number of switch devices managed by this driver. Devices are numbered from 0 to MaxSwitch - 1", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/canwrite": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Indicates whether the specified switch device can be written to", - "description": "
Reports if the specified switch device can be written to, default true. This is false if the device cannot be written to, for example a limit switch or a sensor. Devices are numbered from 0 to MaxSwitch - 1", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/getswitch": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Return the state of switch device id as a boolean", - "description": "
Return the state of switch device id as a boolean. Devices are numbered from 0 to MaxSwitch - 1", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/getswitchdescription": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Gets the description of the specified switch device", - "description": "
Gets the description of the specified switch device. This is to allow a fuller description of the device to be returned, for example for a tool tip. Devices are numbered from 0 to MaxSwitch - 1", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/getswitchname": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Gets the name of the specified switch device", - "description": "
Gets the name of the specified switch device. Devices are numbered from 0 to MaxSwitch - 1", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/getswitchvalue": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Gets the value of the specified switch device as a double", - "description": "
Gets the value of the specified switch device as a double. Devices are numbered from 0 to MaxSwitch - 1, The value of this switch is expected to be between MinSwitchValue and MaxSwitchValue.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/minswitchvalue": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Gets the minimum value of the specified switch device as a double", - "description": "
Gets the minimum value of the specified switch device as a double. Devices are numbered from 0 to MaxSwitch - 1.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/maxswitchvalue": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Gets the maximum value of the specified switch device as a double", - "description": "
Gets the maximum value of the specified switch device as a double. Devices are numbered from 0 to MaxSwitch - 1.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/switchstep": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Returns the step size that this device supports (the difference between successive values of the device).", - "description": "
Returns the step size that this device supports (the difference between successive values of the device). Devices are numbered from 0 to MaxSwitch - 1.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/setswitch": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Sets a switch controller device to the specified state, true or false", - "description": "
Sets a switch controller device to the specified state, true or false.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "ID", - "State" - ], - "type": "object", - "properties": { - "ID": { - "type": "integer", - "description": "The device number (0 to MaxSwitch - 1)", - "format": "int32", - "default": 0 - }, - "State": { - "type": "boolean", - "description": "The required control state(True or False)" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ID": { - "style": "form" - }, - "State": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/setswitchname": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Sets a switch device name to the specified value", - "description": "
Sets a switch device name to the specified value.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "ID", - "Name" - ], - "type": "object", - "properties": { - "ID": { - "type": "integer", - "description": "The device number (0 to MaxSwitch - 1)", - "format": "int32", - "default": 0 - }, - "Name": { - "type": "string", - "description": "The name of the device" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ID": { - "style": "form" - }, - "Name": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/setswitchvalue": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Sets a switch device value to the specified value", - "description": "
Sets a switch device value to the specified value.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "ID", - "Value" - ], - "type": "object", - "properties": { - "ID": { - "type": "integer", - "description": "The device number (0 to MaxSwitch - 1)", - "format": "int32", - "default": 0 - }, - "Value": { - "type": "number", - "description": "The value to be set, between MinSwitchValue and MaxSwitchValue", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ID": { - "style": "form" - }, - "Value": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/action": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Switch" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/description": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Switch" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/name": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtotarget": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Synchronously slew to the TargetRightAscension and TargetDeclination coordinates.", - "description": "
Move the telescope to the TargetRightAscension and TargetDeclination equatorial coordinates, return when slew is complete", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtotargetasync": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Asynchronously slew to the TargetRightAscension and TargetDeclination coordinates.", - "description": "
Move the telescope to the TargetRightAscension and TargetDeclination equatorial coordinates, return immediatley after the slew starts. The client can poll the Slewing method to determine when the mount reaches the intended coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/synctoaltaz": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Syncs to the given local horizontal coordinates.", - "description": "
Matches the scope's local horizontal coordinates to the given local horizontal coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Altitude", - "Azimuth" - ], - "type": "object", - "properties": { - "Azimuth": { - "type": "number", - "description": "Azimuth coordinate (degrees, North-referenced, positive East/clockwise)", - "format": "double" - }, - "Altitude": { - "type": "number", - "description": "Altitude coordinate (degrees, positive up)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Azimuth": { - "style": "form" - }, - "Altitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/synctocoordinates": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Syncs to the given equatorial coordinates.", - "description": "
Matches the scope's equatorial coordinates to the given equatorial coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Declination", - "RightAscension" - ], - "type": "object", - "properties": { - "RightAscension": { - "type": "number", - "description": "Right Ascension coordinate (hours)", - "format": "double" - }, - "Declination": { - "type": "number", - "description": "Declination coordinate (degrees)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "RightAscension": { - "style": "form" - }, - "Declination": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/synctotarget": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Syncs to the TargetRightAscension and TargetDeclination coordinates.", - "description": "
Matches the scope's equatorial coordinates to the TargetRightAscension and TargetDeclination equatorial coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/targetdeclination": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current target declination.", - "description": "
The declination (degrees, positive North) for the target of an equatorial slew or sync operation", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the target declination of a slew or sync.", - "description": "
Sets the declination (degrees, positive North) for the target of an equatorial slew or sync operation", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "TargetDeclination" - ], - "type": "object", - "properties": { - "TargetDeclination": { - "type": "number", - "description": "Target declination(degrees)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "TargetDeclination": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/targetrightascension": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current target right ascension.", - "description": "
The right ascension (hours) for the target of an equatorial slew or sync operation", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the target right ascension of a slew or sync.", - "description": "
Sets the right ascension (hours) for the target of an equatorial slew or sync operation", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "TargetRightAscension" - ], - "type": "object", - "properties": { - "TargetRightAscension": { - "type": "number", - "description": "Target right ascension(hours)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "TargetRightAscension": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/tracking": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope is tracking.", - "description": "
Returns the state of the telescope's sidereal tracking drive.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Enables or disables telescope tracking.", - "description": "
Sets the state of the telescope's sidereal tracking drive.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Tracking" - ], - "type": "object", - "properties": { - "Tracking": { - "type": "boolean", - "description": "Tracking enabled / disabled" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Tracking": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/trackingrate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current tracking rate.", - "description": "
The current tracking rate of the telescope's sidereal drive.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the mount's tracking rate.", - "description": "
Sets the tracking rate of the telescope's sidereal drive. 0 = driveSidereal, 1 = driveLunar, 2 = driveSolar, 3 = driveKing", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "TrackingRate" - ], - "type": "object", - "properties": { - "TrackingRate": { - "type": "integer", - "description": "New tracking rate", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "TrackingRate": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/trackingrates": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns a collection of supported DriveRates values.", - "description": "
Returns an array of supported DriveRates values that describe the permissible values of the TrackingRate property for this telescope type.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DriveRatesResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/utcdate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the UTC date/time of the telescope's internal clock.", - "description": "
The UTC date/time of the telescope's internal clock in ISO 8601 format including fractional seconds. The general format (in Microsoft custom date format style) is yyyy-MM-ddTHH:mm:ss.fffffffZ E.g. 2016-03-04T17:45:31.1234567Z or 2016-11-14T07:03:08.1234567Z Please note the compulsory trailing Z indicating the 'Zulu', UTC time zone.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the UTC date/time of the telescope's internal clock.", - "description": "
The UTC date/time of the telescope's internal clock in ISO 8601 format including fractional seconds. The general format (in Microsoft custom date format style) is yyyy-MM-ddTHH:mm:ss.fffffffZ E.g. 2016-03-04T17:45:31.1234567Z or 2016-11-14T07:03:08.1234567Z Please note the compulsory trailing Z indicating the 'Zulu', UTC time zone.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "UTCDate" - ], - "type": "object", - "properties": { - "UTCDate": { - "type": "string", - "description": "UTC date/time in ISO 8601 format.", - "format": "date-time" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "UTCDate": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/unpark": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Unparks the mount.", - "description": "
Takes telescope out of the Parked state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/abortslew": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Immediately stops a slew in progress.", - "description": "
Immediately Stops a slew in progress.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/alignmentmode": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current mount alignment mode", - "description": "
Returns the alignment mode of the mount (Alt/Az, Polar, German Polar). The alignment mode is specified as an integer value from the AlignmentModes Enum.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/altitude": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the mount's altitude above the horizon.", - "description": "
The altitude above the local horizon of the mount's current position (degrees, positive up)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/aperturearea": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the telescope's aperture.", - "description": "
The area of the telescope's aperture, taking into account any obstructions (square meters)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/aperturediameter": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the telescope's effective aperture.", - "description": "
The telescope's effective aperture diameter (meters)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/athome": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the mount is at the home position.", - "description": "
True if the mount is stopped in the Home position. Set only following a FindHome() operation, and reset with any slew operation. This property must be False if the telescope does not support homing.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/atpark": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope is at the park position.", - "description": "
True if the telescope has been put into the parked state by the see Park() method. Set False by calling the Unpark() method.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/axisrates": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the rates at which the telescope may be moved about the specified axis.", - "description": "
The rates at which the telescope may be moved about the specified axis by the MoveAxis(TelescopeAxes, Double) method.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "Axis", - "in": "query", - "description": "The axis about which rate information is desired. 0 = axisPrimary, 1 = axisSecondary, 2 = axisTertiary.", - "required": true, - "schema": { - "$ref": "#/components/schemas/TelescopeAxis" - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AxisRatesResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/azimuth": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the mount's azimuth.", - "description": "
The azimuth at the local horizon of the mount's current position (degrees, North-referenced, positive East/clockwise).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canfindhome": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the mount can find the home position.", - "description": "
True if this telescope is capable of programmed finding its home position (FindHome() method).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canmoveaxis": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can move the requested axis.", - "description": "
True if this telescope can move the requested axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "Axis", - "in": "query", - "description": "The axis about which rate information is desired. 0 = axisPrimary, 1 = axisSecondary, 2 = axisTertiary.", - "required": true, - "schema": { - "$ref": "#/components/schemas/TelescopeAxis" - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canpark": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can be parked.", - "description": "
True if this telescope is capable of programmed parking (Park() method)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canpulseguide": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can be pulse guided.", - "description": "
True if this telescope is capable of software-pulsed guiding (via the PulseGuide(GuideDirections, Int32) method)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansetdeclinationrate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the DeclinationRate property can be changed.", - "description": "
True if the DeclinationRate property can be changed to provide offset tracking in the declination axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansetguiderates": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the Guide Rates can be changed.", - "description": "
True if the guide rate properties used for PulseGuide(GuideDirections, Int32) can be adjusted.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansetpark": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope park position can be set.", - "description": "
True if this telescope is capable of programmed setting of its park position (SetPark() method)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansetpierside": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope SideOfPier can be set.", - "description": "
True if the SideOfPier property can be set, meaning that the mount can be forced to flip.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansetrightascensionrate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the RightAscensionRate property can be changed.", - "description": "
True if the RightAscensionRate property can be changed to provide offset tracking in the right ascension axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansettracking": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the Tracking property can be changed.", - "description": "
True if the Tracking property can be changed, turning telescope sidereal tracking on and off.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canslew": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can slew synchronously.", - "description": "
True if this telescope is capable of programmed slewing (synchronous or asynchronous) to equatorial coordinates", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canslewaltaz": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can slew synchronously to AltAz coordinates.", - "description": "
True if this telescope is capable of programmed slewing (synchronous or asynchronous) to local horizontal coordinates", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canslewaltazasync": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can slew asynchronously to AltAz coordinates.", - "description": "
True if this telescope is capable of programmed asynchronous slewing to local horizontal coordinates", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canslewasync": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can slew asynchronously.", - "description": "
True if this telescope is capable of programmed asynchronous slewing to equatorial coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansync": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can sync to equatorial coordinates.", - "description": "
True if this telescope is capable of programmed syncing to equatorial coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansyncaltaz": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can sync to local horizontal coordinates.", - "description": "
True if this telescope is capable of programmed syncing to local horizontal coordinates", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canunpark": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can be unparked.", - "description": "
True if this telescope is capable of programmed unparking (Unpark() method)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/declination": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the mount's declination.", - "description": "
The declination (degrees) of the mount's current equatorial coordinates, in the coordinate system given by the EquatorialSystem property. Reading the property will raise an error if the value is unavailable.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/declinationrate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the telescope's declination tracking rate.", - "description": "
The declination tracking rate (arcseconds per SI second, default = 0.0). Please note that rightascensionrate units are arcseconds per sidereal second.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the telescope's declination tracking rate.", - "description": "
Sets the declination tracking rate (arcseconds per SI second). Please note that rightascensionrate units are arcseconds per sidereal second.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "DeclinationRate" - ], - "type": "object", - "properties": { - "DeclinationRate": { - "type": "number", - "description": "Declination tracking rate (arcseconds per SI second). Please note that rightascensionrate units are arcseconds per sidereal second.", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "DeclinationRate": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/destinationsideofpier": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Predicts the pointing state after a German equatorial mount slews to given coordinates.", - "description": "
Predicts the pointing state that a German equatorial mount will be in if it slews to the given coordinates. The return value will be one of - 0 = pierEast, 1 = pierWest, -1 = pierUnknown", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "RightAscension", - "in": "query", - "description": "Right Ascension coordinate (0.0 to 23.99999999 hours)", - "required": true, - "schema": { - "type": "number", - "description": "Right Ascension coordinate (0.0 to 23.99999999 hours)", - "format": "double" - } - }, - { - "name": "Declination", - "in": "query", - "description": "Declination coordinate (-90.0 to +90.0 degrees)", - "required": true, - "schema": { - "type": "number", - "description": "Declination coordinate (-90.0 to +90.0 degrees)", - "format": "double" - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/doesrefraction": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether atmospheric refraction is applied to coordinates.", - "description": "
True if the telescope or driver applies atmospheric refraction to coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Determines whether atmospheric refraction is applied to coordinates.", - "description": "
Determines whether atmospheric refraction is applied to coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "DoesRefraction" - ], - "type": "object", - "properties": { - "DoesRefraction": { - "type": "boolean", - "description": "Determines whether atmospheric refraction is applied to coordinates." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "DoesRefraction": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/equatorialsystem": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current equatorial coordinate system used by this telescope.", - "description": "
Returns the current equatorial coordinate system used by this telescope (e.g. Topocentric or J2000).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/findhome": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Moves the mount to the \"home\" position.", - "description": "
Locates the telescope's \"home\" position (synchronous)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/focallength": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the telescope's focal length in meters.", - "description": "
The telescope's focal length in meters", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/guideratedeclination": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Sets the current Declination rate offset for telescope guiding.", - "description": "
The current Declination movement rate offset for telescope guiding (degrees/sec)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current Declination rate offset for telescope guiding", - "description": "
Sets the current Declination movement rate offset for telescope guiding (degrees/sec).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "GuideRateDeclination" - ], - "type": "object", - "properties": { - "GuideRateDeclination": { - "type": "number", - "description": "Declination movement rate offset degrees/sec).", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "GuideRateDeclination": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/guideraterightascension": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current RightAscension rate offset for telescope guiding", - "description": "
The current RightAscension movement rate offset for telescope guiding (degrees/sec)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the current RightAscension rate offset for telescope guiding.", - "description": "
Sets the current RightAscension movement rate offset for telescope guiding (degrees/sec).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "GuideRateRightAscension" - ], - "type": "object", - "properties": { - "GuideRateRightAscension": { - "type": "number", - "description": "RightAscension movement rate offset (degrees/sec).", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "GuideRateRightAscension": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/ispulseguiding": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope is currently executing a PulseGuide command", - "description": "
True if a PulseGuide(GuideDirections, Int32) command is in progress, False otherwise", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/moveaxis": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Moves a telescope axis at the given rate.", - "description": "
Move the telescope in one axis at the given rate.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Axis", - "Rate" - ], - "type": "object", - "properties": { - "Axis": { - "$ref": "#/components/schemas/TelescopeAxis" - }, - "Rate": { - "type": "number", - "description": "The rate of motion (deg/sec) about the specified axis", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Axis": { - "style": "form" - }, - "Rate": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/park": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Park the mount", - "description": "
Move the telescope to its park position, stop all motion (or restrict to a small safe range), and set AtPark to True.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/pulseguide": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Moves the scope in the given direction for the given time.", - "description": "
Moves the scope in the given direction for the given interval or time at the rate given by the corresponding guide rate property", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Direction", - "Duration" - ], - "type": "object", - "properties": { - "Direction": { - "$ref": "#/components/schemas/GuideDirection" - }, - "Duration": { - "type": "integer", - "description": "The duration of the guide-rate motion (milliseconds)", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Direction": { - "style": "form" - }, - "Duration": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/rightascension": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the mount's right ascension coordinate.", - "description": "
The right ascension (hours) of the mount's current equatorial coordinates, in the coordinate system given by the EquatorialSystem property", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/rightascensionrate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the telescope's right ascension tracking rate.", - "description": "
The right ascension tracking rate (arcseconds per sidereal second, default = 0.0). Please note that the declinationrate units are arcseconds per SI second.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the telescope's right ascension tracking rate.", - "description": "
Sets the right ascension tracking rate (arcseconds per sidereal second). Please note that the declinationrate units are arcseconds per SI second.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "RightAscensionRate" - ], - "type": "object", - "properties": { - "RightAscensionRate": { - "type": "number", - "description": "Right ascension tracking rate (arcseconds per sideral second). Please note that the declinationrate units are arcseconds per SI second.", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "RightAscensionRate": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/setpark": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the telescope's park position", - "description": "
Sets the telescope's park position to be its current position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/sideofpier": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the mount's pointing state.", - "description": "
Indicates the pointing state of the mount. 0 = pierEast, 1 = pierWest, -1= pierUnknown", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the mount's pointing state.", - "description": "
Sets the pointing state of the mount. 0 = pierEast, 1 = pierWest", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SideOfPier" - ], - "type": "object", - "properties": { - "SideOfPier": { - "$ref": "#/components/schemas/PointingState" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SideOfPier": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/siderealtime": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the local apparent sidereal time.", - "description": "
The local apparent sidereal time from the telescope's internal clock (hours, sidereal).The local apparent sidereal time from the telescope's internal clock (hours, sidereal).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/siteelevation": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the observing site's elevation above mean sea level.", - "description": "
The elevation above mean sea level (meters) of the site at which the telescope is located.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the observing site's elevation above mean sea level.", - "description": "
Sets the elevation above mean sea level (metres) of the site at which the telescope is located.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SiteElevation" - ], - "type": "object", - "properties": { - "SiteElevation": { - "type": "number", - "description": "Elevation above mean sea level (metres).", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SiteElevation": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/sitelatitude": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the observing site's latitude.", - "description": "
The geodetic(map) latitude (degrees, positive North, WGS84) of the site at which the telescope is located.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the observing site's latitude.", - "description": "
Sets the observing site's latitude (degrees).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SiteLatitude" - ], - "type": "object", - "properties": { - "SiteLatitude": { - "type": "number", - "description": "Site latitude (degrees)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SiteLatitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/sitelongitude": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the observing site's longitude.", - "description": "
The longitude (degrees, positive East, WGS84) of the site at which the telescope is located.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the observing site's longitude.", - "description": "
Sets the observing site's longitude (degrees, positive East, WGS84).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SiteLongitude" - ], - "type": "object", - "properties": { - "SiteLongitude": { - "type": "number", - "description": "Site longitude (degrees, positive East, WGS84)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SiteLongitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewing": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope is currently slewing.", - "description": "
True if telescope is currently moving in response to one of the Slew methods or the MoveAxis(TelescopeAxes, Double) method, False at all other times.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewsettletime": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the post-slew settling time.", - "description": "
Returns the post-slew settling time (sec.).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the post-slew settling time.", - "description": "
Sets the post-slew settling time (integer sec.).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SlewSettleTime" - ], - "type": "object", - "properties": { - "SlewSettleTime": { - "type": "integer", - "description": "Settling time (integer sec.).", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SlewSettleTime": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtoaltaz": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Synchronously slew to the given local horizontal coordinates.", - "description": "
Move the telescope to the given local horizontal coordinates, return when slew is complete", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Altitude", - "Azimuth" - ], - "type": "object", - "properties": { - "Azimuth": { - "type": "number", - "description": "Azimuth coordinate (degrees, North-referenced, positive East/clockwise)", - "format": "double" - }, - "Altitude": { - "type": "number", - "description": "Altitude coordinate (degrees, positive up)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Azimuth": { - "style": "form" - }, - "Altitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtoaltazasync": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Asynchronously slew to the given local horizontal coordinates.", - "description": "
Move the telescope to the given local horizontal coordinates, return immediately after the slew starts. The client can poll the Slewing method to determine when the mount reaches the intended coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Altitude", - "Azimuth" - ], - "type": "object", - "properties": { - "Azimuth": { - "type": "number", - "description": "Azimuth coordinate (degrees, North-referenced, positive East/clockwise)", - "format": "double" - }, - "Altitude": { - "type": "number", - "description": "Altitude coordinate (degrees, positive up)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Azimuth": { - "style": "form" - }, - "Altitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtocoordinates": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Synchronously slew to the given equatorial coordinates.", - "description": "
Move the telescope to the given equatorial coordinates, return when slew is complete", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Declination", - "RightAscension" - ], - "type": "object", - "properties": { - "RightAscension": { - "type": "number", - "description": "Right Ascension coordinate (hours)", - "format": "double" - }, - "Declination": { - "type": "number", - "description": "Declination coordinate (degrees)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "RightAscension": { - "style": "form" - }, - "Declination": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtocoordinatesasync": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Synchronously slew to the given equatorial coordinates.", - "description": "
Move the telescope to the given equatorial coordinates, return when slew is complete", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Declination", - "RightAscension" - ], - "type": "object", - "properties": { - "RightAscension": { - "type": "number", - "description": "Right Ascension coordinate (hours)", - "format": "double" - }, - "Declination": { - "type": "number", - "description": "Declination coordinate (degrees)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "RightAscension": { - "style": "form" - }, - "Declination": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/action": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/description": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/name": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - } - }, - "components": { - "schemas": { - "AlpacaConfiguredDevice": { - "type": "object", - "properties": { - "DeviceName": { - "type": "string", - "description": "A short name for this device that a user would expect to see in a list of available devices.", - "nullable": true - }, - "DeviceType": { - "type": "string", - "description": "One of the supported ASCOM Devices types such as Telescope, Camera, Focuser etc.", - "nullable": true - }, - "DeviceNumber": { - "type": "integer", - "description": "The device number that must be used to access this device through the Alpaca Device API.", - "format": "int32" - }, - "UniqueID": { - "type": "string", - "description": "\"This should be the ProgID for COM devices or a GUID for native Alpaca devices.\"", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Returns an array of device description objects, providing unique information for each served device, enabling them to be accessed through the Alpaca Device API." - }, - "AlpacaConfiguredDevicesResponse": { - "type": "object", - "properties": { - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.Response.ErrorNumber must also be returned.", - "nullable": true - }, - "Value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AlpacaConfiguredDevice" - }, - "description": "AlpacaConfiguredDevicesResponse value returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Class representing an Alpaca device's configured devices response" - }, - "AlpacaDescriptionResponse": { - "type": "object", - "properties": { - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.Response.ErrorNumber must also be returned.", - "nullable": true - }, - "Value": { - "$ref": "#/components/schemas/AlpacaDeviceDescription" - } - }, - "additionalProperties": false, - "description": "The response for the AlpacaDeviceDescription" - }, - "AlpacaDeviceDescription": { - "type": "object", - "properties": { - "ServerName": { - "type": "string", - "description": "The device or server's overall name.", - "nullable": true - }, - "Manufacturer": { - "type": "string", - "description": "The manufacturer's name.", - "nullable": true - }, - "ManufacturerVersion": { - "type": "string", - "description": "The device or server's version number.", - "nullable": true - }, - "Location": { - "type": "string", - "description": "The device or server's location.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Returns cross-cutting information that applies to all devices available at this URL:Port." - }, - "AlpacaErrors": { - "enum": [ - 0, - 1024, - 1025, - 1026, - 1031, - 1032, - 1033, - 1035, - 1036, - 1279, - 1280, - 4095 - ], - "type": "integer", - "description": "Error numbers for use by Alpaca applications and drivers in the range 0x400 to 0xFFF.", - "format": "int32" - }, - "ArrayType": { - "enum": [ - 0, - 1, - 2, - 3 - ], - "type": "integer", - "description": "Image array element type enumeration", - "format": "int32" - }, - "Assembly": { - "type": "object", - "properties": { - "DefinedTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TypeInfo" - }, - "nullable": true, - "readOnly": true - }, - "ExportedTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - }, - "CodeBase": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "EntryPoint": { - "$ref": "#/components/schemas/MethodInfo" - }, - "FullName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "ImageRuntimeVersion": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "IsDynamic": { - "type": "boolean", - "readOnly": true - }, - "Location": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "ReflectionOnly": { - "type": "boolean", - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "IsFullyTrusted": { - "type": "boolean", - "readOnly": true - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "EscapedCodeBase": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "ManifestModule": { - "$ref": "#/components/schemas/Module" - }, - "Modules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Module" - }, - "nullable": true, - "readOnly": true - }, - "GlobalAssemblyCache": { - "type": "boolean", - "readOnly": true, - "deprecated": true - }, - "HostContext": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "SecurityRuleSet": { - "$ref": "#/components/schemas/SecurityRuleSet" - } - }, - "additionalProperties": false - }, - "AxisRate": { - "type": "object", - "properties": { - "Minimum": { - "type": "number", - "description": "The minimum rate (degrees per second) This must always be a positive number. It indicates the maximum rate in either direction about the axis.", - "format": "double" - }, - "Maximum": { - "type": "number", - "description": "The maximum rate (degrees per second) This must always be a positive number. It indicates the maximum rate in either direction about the axis.", - "format": "double" - } - }, - "additionalProperties": false, - "description": "Describe a rate at which the telescope may be moved about the specified axis by the MoveAxis(TelescopeAxes, Double) method." - }, - "AxisRatesResponse": { - "type": "object", - "properties": { - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.Response.ErrorNumber must also be returned.", - "nullable": true - }, - "Value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AxisRate" - }, - "description": "Axis rate collection returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a collection of ASCOM.Common.DeviceInterfaces.AxisRate values." - }, - "BoolResponse": { - "type": "object", - "properties": { - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.Response.ErrorNumber must also be returned.", - "nullable": true - }, - "Value": { - "type": "boolean", - "description": "Boolean value returned by the device" - } - }, - "additionalProperties": false, - "description": "Alpaca boolean response class" - }, - "CallingConventions": { - "enum": [ - 1, - 2, - 3, - 32, - 64 - ], - "type": "integer", - "format": "int32" - }, - "ConstructorInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "Attributes": { - "$ref": "#/components/schemas/MethodAttributes" - }, - "MethodImplementationFlags": { - "$ref": "#/components/schemas/MethodImplAttributes" - }, - "CallingConvention": { - "$ref": "#/components/schemas/CallingConventions" - }, - "IsAbstract": { - "type": "boolean", - "readOnly": true - }, - "IsConstructor": { - "type": "boolean", - "readOnly": true - }, - "IsFinal": { - "type": "boolean", - "readOnly": true - }, - "IsHideBySig": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsStatic": { - "type": "boolean", - "readOnly": true - }, - "IsVirtual": { - "type": "boolean", - "readOnly": true - }, - "IsAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamily": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyAndAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyOrAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsConstructedGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethodDefinition": { - "type": "boolean", - "readOnly": true - }, - "ContainsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "MethodHandle": { - "$ref": "#/components/schemas/RuntimeMethodHandle" - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - } - }, - "additionalProperties": false - }, - "CustomAttributeData": { - "type": "object", - "properties": { - "AttributeType": { - "$ref": "#/components/schemas/Type" - }, - "Constructor": { - "$ref": "#/components/schemas/ConstructorInfo" - }, - "ConstructorArguments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeTypedArgument" - }, - "nullable": true, - "readOnly": true - }, - "NamedArguments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeNamedArgument" - }, - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false - }, - "CustomAttributeNamedArgument": { - "type": "object", - "properties": { - "MemberInfo": { - "$ref": "#/components/schemas/MemberInfo" - }, - "TypedValue": { - "$ref": "#/components/schemas/CustomAttributeTypedArgument" - }, - "MemberName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "IsField": { - "type": "boolean", - "readOnly": true - } - }, - "additionalProperties": false - }, - "CustomAttributeTypedArgument": { - "type": "object", - "properties": { - "ArgumentType": { - "$ref": "#/components/schemas/Type" - }, - "Value": { - "nullable": true - } - }, - "additionalProperties": false - }, - "DoubleResponse": { - "type": "object", - "properties": { - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.Response.ErrorNumber must also be returned.", - "nullable": true - }, - "Value": { - "type": "number", - "description": "Double value returned by the device", - "format": "double" - } - }, - "additionalProperties": false, - "description": "Response that returns a double value." - }, - "DriveRate": { - "enum": [ - 0, - 1, - 2, - 3 - ], - "type": "integer", - "description": "Well-known telescope tracking rates.", - "format": "int32" - }, - "DriveRatesResponse": { - "type": "object", - "properties": { - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.Response.ErrorNumber must also be returned.", - "nullable": true - }, - "Value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DriveRate" - }, - "description": "Drive rate collection returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a collection of ASCOM.Common.DeviceInterfaces.DriveRate values" - }, - "EventAttributes": { - "enum": [ - 0, - 512, - 1024 - ], - "type": "integer", - "format": "int32" - }, - "EventInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Attributes": { - "$ref": "#/components/schemas/EventAttributes" - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "AddMethod": { - "$ref": "#/components/schemas/MethodInfo" - }, - "RemoveMethod": { - "$ref": "#/components/schemas/MethodInfo" - }, - "RaiseMethod": { - "$ref": "#/components/schemas/MethodInfo" - }, - "IsMulticast": { - "type": "boolean", - "readOnly": true - }, - "EventHandlerType": { - "$ref": "#/components/schemas/Type" - } - }, - "additionalProperties": false - }, - "Exception": { - "type": "object", - "properties": { - "TargetSite": { - "$ref": "#/components/schemas/MethodBase" - }, - "Message": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "Data": { - "type": "object", - "additionalProperties": { }, - "nullable": true, - "readOnly": true - }, - "InnerException": { - "$ref": "#/components/schemas/Exception" - }, - "HelpLink": { - "type": "string", - "nullable": true - }, - "Source": { - "type": "string", - "nullable": true - }, - "HResult": { - "type": "integer", - "format": "int32" - }, - "StackTrace": { - "type": "string", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false - }, - "FieldAttributes": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 5, - 6, - 7, - 16, - 32, - 64, - 128, - 256, - 512, - 1024, - 4096, - 8192, - 32768, - 38144 - ], - "type": "integer", - "format": "int32" - }, - "FieldInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Attributes": { - "$ref": "#/components/schemas/FieldAttributes" - }, - "FieldType": { - "$ref": "#/components/schemas/Type" - }, - "IsInitOnly": { - "type": "boolean", - "readOnly": true - }, - "IsLiteral": { - "type": "boolean", - "readOnly": true - }, - "IsNotSerialized": { - "type": "boolean", - "readOnly": true - }, - "IsPinvokeImpl": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsStatic": { - "type": "boolean", - "readOnly": true - }, - "IsAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamily": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyAndAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyOrAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "FieldHandle": { - "$ref": "#/components/schemas/RuntimeFieldHandle" - } - }, - "additionalProperties": false - }, - "GenericParameterAttributes": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 8, - 16, - 28 - ], - "type": "integer", - "format": "int32" - }, - "GuideDirection": { - "enum": [ - 0, - 1, - 2, - 3 - ], - "type": "integer", - "description": "The direction in which the guide-rate motion is to be made.", - "format": "int32" - }, - "ICustomAttributeProvider": { - "type": "object", - "additionalProperties": false - }, - "IntArray2DResponse": { - "type": "object", - "properties": { - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.Response.ErrorNumber must also be returned.", - "nullable": true - }, - "Type": { - "$ref": "#/components/schemas/ArrayType" - }, - "Rank": { - "type": "integer", - "description": "The array's rank, will be 2 (single plane image (monochrome)).", - "format": "int32", - "readOnly": true - }, - "Value": { - "type": "array", - "items": { }, - "description": "2D image array of int32 values", - "nullable": true - } - }, - "additionalProperties": false, - "description": "2 dimension image array response" - }, - "IntListResponse": { - "type": "object", - "properties": { - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.Response.ErrorNumber must also be returned.", - "nullable": true - }, - "Value": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "Integer collection returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a collection of integer values." - }, - "IntPtr": { - "type": "object", - "additionalProperties": false - }, - "IntResponse": { - "type": "object", - "properties": { - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.Response.ErrorNumber must also be returned.", - "nullable": true - }, - "Value": { - "type": "integer", - "description": "Integer value returned by the device", - "format": "int32" - } - }, - "additionalProperties": false, - "description": "Response that returns an integer value." - }, - "LayoutKind": { - "enum": [ - 0, - 2, - 3 - ], - "type": "integer", - "format": "int32" - }, - "MemberInfo": { - "type": "object", - "properties": { - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "additionalProperties": false - }, - "MemberTypes": { - "enum": [ - 1, - 2, - 4, - 8, - 16, - 32, - 64, - 128, - 191 - ], - "type": "integer", - "format": "int32" - }, - "MethodAttributes": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 5, - 6, - 7, - 8, - 16, - 32, - 64, - 128, - 256, - 512, - 1024, - 2048, - 4096, - 8192, - 16384, - 32768, - 53248 - ], - "type": "integer", - "format": "int32" - }, - "MethodBase": { - "type": "object", - "properties": { - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "Attributes": { - "$ref": "#/components/schemas/MethodAttributes" - }, - "MethodImplementationFlags": { - "$ref": "#/components/schemas/MethodImplAttributes" - }, - "CallingConvention": { - "$ref": "#/components/schemas/CallingConventions" - }, - "IsAbstract": { - "type": "boolean", - "readOnly": true - }, - "IsConstructor": { - "type": "boolean", - "readOnly": true - }, - "IsFinal": { - "type": "boolean", - "readOnly": true - }, - "IsHideBySig": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsStatic": { - "type": "boolean", - "readOnly": true - }, - "IsVirtual": { - "type": "boolean", - "readOnly": true - }, - "IsAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamily": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyAndAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyOrAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsConstructedGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethodDefinition": { - "type": "boolean", - "readOnly": true - }, - "ContainsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "MethodHandle": { - "$ref": "#/components/schemas/RuntimeMethodHandle" - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - } - }, - "additionalProperties": false - }, - "MethodImplAttributes": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 8, - 16, - 32, - 64, - 128, - 256, - 512, - 4096, - 65535 - ], - "type": "integer", - "format": "int32" - }, - "MethodInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "Attributes": { - "$ref": "#/components/schemas/MethodAttributes" - }, - "MethodImplementationFlags": { - "$ref": "#/components/schemas/MethodImplAttributes" - }, - "CallingConvention": { - "$ref": "#/components/schemas/CallingConventions" - }, - "IsAbstract": { - "type": "boolean", - "readOnly": true - }, - "IsConstructor": { - "type": "boolean", - "readOnly": true - }, - "IsFinal": { - "type": "boolean", - "readOnly": true - }, - "IsHideBySig": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsStatic": { - "type": "boolean", - "readOnly": true - }, - "IsVirtual": { - "type": "boolean", - "readOnly": true - }, - "IsAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamily": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyAndAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyOrAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsConstructedGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethodDefinition": { - "type": "boolean", - "readOnly": true - }, - "ContainsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "MethodHandle": { - "$ref": "#/components/schemas/RuntimeMethodHandle" - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "ReturnParameter": { - "$ref": "#/components/schemas/ParameterInfo" - }, - "ReturnType": { - "$ref": "#/components/schemas/Type" - }, - "ReturnTypeCustomAttributes": { - "$ref": "#/components/schemas/ICustomAttributeProvider" - } - }, - "additionalProperties": false - }, - "Module": { - "type": "object", - "properties": { - "Assembly": { - "$ref": "#/components/schemas/Assembly" - }, - "FullyQualifiedName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "MDStreamVersion": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "ModuleVersionId": { - "type": "string", - "format": "uuid", - "readOnly": true - }, - "ScopeName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "ModuleHandle": { - "$ref": "#/components/schemas/ModuleHandle" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "additionalProperties": false - }, - "ModuleHandle": { - "type": "object", - "properties": { - "MDStreamVersion": { - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "additionalProperties": false - }, - "ParameterAttributes": { - "enum": [ - 0, - 1, - 2, - 4, - 8, - 16, - 4096, - 8192, - 16384, - 32768, - 61440 - ], - "type": "integer", - "format": "int32" - }, - "ParameterInfo": { - "type": "object", - "properties": { - "Attributes": { - "$ref": "#/components/schemas/ParameterAttributes" - }, - "Member": { - "$ref": "#/components/schemas/MemberInfo" - }, - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "ParameterType": { - "$ref": "#/components/schemas/Type" - }, - "Position": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "IsIn": { - "type": "boolean", - "readOnly": true - }, - "IsLcid": { - "type": "boolean", - "readOnly": true - }, - "IsOptional": { - "type": "boolean", - "readOnly": true - }, - "IsOut": { - "type": "boolean", - "readOnly": true - }, - "IsRetval": { - "type": "boolean", - "readOnly": true - }, - "DefaultValue": { - "nullable": true, - "readOnly": true - }, - "RawDefaultValue": { - "nullable": true, - "readOnly": true - }, - "HasDefaultValue": { - "type": "boolean", - "readOnly": true - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "additionalProperties": false - }, - "PointingState": { - "enum": [ - 0, - 1, - -1 - ], - "type": "integer", - "description": "The pointing state of the mount", - "format": "int32" - }, - "PropertyAttributes": { - "enum": [ - 0, - 512, - 1024, - 4096, - 8192, - 16384, - 32768, - 62464 - ], - "type": "integer", - "format": "int32" - }, - "PropertyInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "PropertyType": { - "$ref": "#/components/schemas/Type" - }, - "Attributes": { - "$ref": "#/components/schemas/PropertyAttributes" - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "CanRead": { - "type": "boolean", - "readOnly": true - }, - "CanWrite": { - "type": "boolean", - "readOnly": true - }, - "GetMethod": { - "$ref": "#/components/schemas/MethodInfo" - }, - "SetMethod": { - "$ref": "#/components/schemas/MethodInfo" - } - }, - "additionalProperties": false - }, - "Response": { - "type": "object", - "properties": { - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.Response.ErrorNumber must also be returned.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Defines the properties that are common to all Alpaca responses." - }, - "RuntimeFieldHandle": { - "type": "object", - "properties": { - "Value": { - "$ref": "#/components/schemas/IntPtr" - } - }, - "additionalProperties": false - }, - "RuntimeMethodHandle": { - "type": "object", - "properties": { - "Value": { - "$ref": "#/components/schemas/IntPtr" - } - }, - "additionalProperties": false - }, - "RuntimeTypeHandle": { - "type": "object", - "properties": { - "Value": { - "$ref": "#/components/schemas/IntPtr" - } - }, - "additionalProperties": false - }, - "SecurityRuleSet": { - "enum": [ - 0, - 1, - 2 - ], - "type": "integer", - "format": "int32" - }, - "StringListResponse": { - "type": "object", - "properties": { - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.Response.ErrorNumber must also be returned.", - "nullable": true - }, - "Value": { - "type": "array", - "items": { - "type": "string" - }, - "description": "String collection returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a collection of strings" - }, - "StringResponse": { - "type": "object", - "properties": { - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.Response.ErrorNumber must also be returned.", - "nullable": true - }, - "Value": { - "type": "string", - "description": "String value returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a string value" - }, - "StructLayoutAttribute": { - "type": "object", - "properties": { - "TypeId": { - "nullable": true, - "readOnly": true - }, - "Value": { - "$ref": "#/components/schemas/LayoutKind" - } - }, - "additionalProperties": false - }, - "TelescopeAxis": { - "enum": [ - 0, - 1, - 2 - ], - "type": "integer", - "description": "The telescope axes", - "format": "int32" - }, - "Type": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "IsInterface": { - "type": "boolean", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Namespace": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "AssemblyQualifiedName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "FullName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "Assembly": { - "$ref": "#/components/schemas/Assembly" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "IsNested": { - "type": "boolean", - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "DeclaringMethod": { - "$ref": "#/components/schemas/MethodBase" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "UnderlyingSystemType": { - "$ref": "#/components/schemas/Type" - }, - "IsTypeDefinition": { - "type": "boolean", - "readOnly": true - }, - "IsArray": { - "type": "boolean", - "readOnly": true - }, - "IsByRef": { - "type": "boolean", - "readOnly": true - }, - "IsPointer": { - "type": "boolean", - "readOnly": true - }, - "IsConstructedGenericType": { - "type": "boolean", - "readOnly": true - }, - "IsGenericParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericTypeParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethodParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericType": { - "type": "boolean", - "readOnly": true - }, - "IsGenericTypeDefinition": { - "type": "boolean", - "readOnly": true - }, - "IsSZArray": { - "type": "boolean", - "readOnly": true - }, - "IsVariableBoundArray": { - "type": "boolean", - "readOnly": true - }, - "IsByRefLike": { - "type": "boolean", - "readOnly": true - }, - "HasElementType": { - "type": "boolean", - "readOnly": true - }, - "GenericTypeArguments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - }, - "GenericParameterPosition": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "GenericParameterAttributes": { - "$ref": "#/components/schemas/GenericParameterAttributes" - }, - "Attributes": { - "$ref": "#/components/schemas/TypeAttributes" - }, - "IsAbstract": { - "type": "boolean", - "readOnly": true - }, - "IsImport": { - "type": "boolean", - "readOnly": true - }, - "IsSealed": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsClass": { - "type": "boolean", - "readOnly": true - }, - "IsNestedAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamANDAssem": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamily": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamORAssem": { - "type": "boolean", - "readOnly": true - }, - "IsNestedPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsNestedPublic": { - "type": "boolean", - "readOnly": true - }, - "IsNotPublic": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsAutoLayout": { - "type": "boolean", - "readOnly": true - }, - "IsExplicitLayout": { - "type": "boolean", - "readOnly": true - }, - "IsLayoutSequential": { - "type": "boolean", - "readOnly": true - }, - "IsAnsiClass": { - "type": "boolean", - "readOnly": true - }, - "IsAutoClass": { - "type": "boolean", - "readOnly": true - }, - "IsUnicodeClass": { - "type": "boolean", - "readOnly": true - }, - "IsCOMObject": { - "type": "boolean", - "readOnly": true - }, - "IsContextful": { - "type": "boolean", - "readOnly": true - }, - "IsEnum": { - "type": "boolean", - "readOnly": true - }, - "IsMarshalByRef": { - "type": "boolean", - "readOnly": true - }, - "IsPrimitive": { - "type": "boolean", - "readOnly": true - }, - "IsValueType": { - "type": "boolean", - "readOnly": true - }, - "IsSignatureType": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "StructLayoutAttribute": { - "$ref": "#/components/schemas/StructLayoutAttribute" - }, - "TypeInitializer": { - "$ref": "#/components/schemas/ConstructorInfo" - }, - "TypeHandle": { - "$ref": "#/components/schemas/RuntimeTypeHandle" - }, - "GUID": { - "type": "string", - "format": "uuid", - "readOnly": true - }, - "BaseType": { - "$ref": "#/components/schemas/Type" - }, - "IsSerializable": { - "type": "boolean", - "readOnly": true - }, - "ContainsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "IsVisible": { - "type": "boolean", - "readOnly": true - } - }, - "additionalProperties": false - }, - "TypeAttributes": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 5, - 6, - 7, - 8, - 16, - 24, - 32, - 128, - 256, - 1024, - 2048, - 4096, - 8192, - 16384, - 65536, - 131072, - 196608, - 262144, - 264192, - 1048576, - 12582912 - ], - "type": "integer", - "format": "int32" - }, - "TypeInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "IsInterface": { - "type": "boolean", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Namespace": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "AssemblyQualifiedName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "FullName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "Assembly": { - "$ref": "#/components/schemas/Assembly" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "IsNested": { - "type": "boolean", - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "DeclaringMethod": { - "$ref": "#/components/schemas/MethodBase" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "UnderlyingSystemType": { - "$ref": "#/components/schemas/Type" - }, - "IsTypeDefinition": { - "type": "boolean", - "readOnly": true - }, - "IsArray": { - "type": "boolean", - "readOnly": true - }, - "IsByRef": { - "type": "boolean", - "readOnly": true - }, - "IsPointer": { - "type": "boolean", - "readOnly": true - }, - "IsConstructedGenericType": { - "type": "boolean", - "readOnly": true - }, - "IsGenericParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericTypeParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethodParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericType": { - "type": "boolean", - "readOnly": true - }, - "IsGenericTypeDefinition": { - "type": "boolean", - "readOnly": true - }, - "IsSZArray": { - "type": "boolean", - "readOnly": true - }, - "IsVariableBoundArray": { - "type": "boolean", - "readOnly": true - }, - "IsByRefLike": { - "type": "boolean", - "readOnly": true - }, - "HasElementType": { - "type": "boolean", - "readOnly": true - }, - "GenericTypeArguments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - }, - "GenericParameterPosition": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "GenericParameterAttributes": { - "$ref": "#/components/schemas/GenericParameterAttributes" - }, - "Attributes": { - "$ref": "#/components/schemas/TypeAttributes" - }, - "IsAbstract": { - "type": "boolean", - "readOnly": true - }, - "IsImport": { - "type": "boolean", - "readOnly": true - }, - "IsSealed": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsClass": { - "type": "boolean", - "readOnly": true - }, - "IsNestedAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamANDAssem": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamily": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamORAssem": { - "type": "boolean", - "readOnly": true - }, - "IsNestedPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsNestedPublic": { - "type": "boolean", - "readOnly": true - }, - "IsNotPublic": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsAutoLayout": { - "type": "boolean", - "readOnly": true - }, - "IsExplicitLayout": { - "type": "boolean", - "readOnly": true - }, - "IsLayoutSequential": { - "type": "boolean", - "readOnly": true - }, - "IsAnsiClass": { - "type": "boolean", - "readOnly": true - }, - "IsAutoClass": { - "type": "boolean", - "readOnly": true - }, - "IsUnicodeClass": { - "type": "boolean", - "readOnly": true - }, - "IsCOMObject": { - "type": "boolean", - "readOnly": true - }, - "IsContextful": { - "type": "boolean", - "readOnly": true - }, - "IsEnum": { - "type": "boolean", - "readOnly": true - }, - "IsMarshalByRef": { - "type": "boolean", - "readOnly": true - }, - "IsPrimitive": { - "type": "boolean", - "readOnly": true - }, - "IsValueType": { - "type": "boolean", - "readOnly": true - }, - "IsSignatureType": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "StructLayoutAttribute": { - "$ref": "#/components/schemas/StructLayoutAttribute" - }, - "TypeInitializer": { - "$ref": "#/components/schemas/ConstructorInfo" - }, - "TypeHandle": { - "$ref": "#/components/schemas/RuntimeTypeHandle" - }, - "GUID": { - "type": "string", - "format": "uuid", - "readOnly": true - }, - "BaseType": { - "$ref": "#/components/schemas/Type" - }, - "IsSerializable": { - "type": "boolean", - "readOnly": true - }, - "ContainsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "IsVisible": { - "type": "boolean", - "readOnly": true - }, - "GenericTypeParameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredConstructors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConstructorInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredEvents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EventInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FieldInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredMembers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MemberInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MethodInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredNestedTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TypeInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredProperties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyInfo" - }, - "nullable": true, - "readOnly": true - }, - "ImplementedInterfaces": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false - } - } - } -} \ No newline at end of file diff --git a/templates/AlpacaDeviceAPI_v2_plat7-0.4.1.json b/templates/AlpacaDeviceAPI_v2_plat7-0.4.1.json deleted file mode 100644 index 20890e8..0000000 --- a/templates/AlpacaDeviceAPI_v2_plat7-0.4.1.json +++ /dev/null @@ -1,36252 +0,0 @@ -{ - "openapi": "3.0.1", - "info": { - "title": "ASCOM Alpaca Simulators", - "description": "Please note that the Alpaca API documentation on the ASCOM website is the canonical version. There are several issues with this auto generated version that will be resolved in future versions. This is currently provided only for testing..", - "version": "v0" - }, - "paths": { - "/api/v1/camera/{DeviceNumber}/bayeroffsetx": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the X offset of the Bayer matrix.", - "description": "\r\nReturns the X offset of the Bayer matrix, as defined in SensorType.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/bayeroffsety": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the Y offset of the Bayer matrix.", - "description": "\r\nReturns the Y offset of the Bayer matrix, as defined in SensorType.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/binx": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the binning factor for the X axis.", - "description": "\r\nReturns the binning factor for the X axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the binning factor for the X axis.", - "description": "\r\nSets the binning factor for the X axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "BinX" - ], - "type": "object", - "properties": { - "BinX": { - "type": "integer", - "description": "The X binning value", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "BinX": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/biny": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the binning factor for the Y axis.", - "description": "\r\nReturns the binning factor for the Y axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the binning factor for the Y axis.", - "description": "\r\nSets the binning factor for the Y axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "BinY" - ], - "type": "object", - "properties": { - "BinY": { - "type": "integer", - "description": "The Y binning value", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "BinY": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/camerastate": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the camera operational state.", - "description": "\r\nReturns the current camera operational state as an integer. 0 = CameraIdle , 1 = CameraWaiting , 2 = CameraExposing , 3 = CameraReading , 4 = CameraDownload , 5 = CameraError", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/cameraxsize": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the width of the CCD camera chip.", - "description": "\r\nReturns the width of the CCD camera chip in unbinned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/cameraysize": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the height of the CCD camera chip.", - "description": "\r\nReturns the height of the CCD camera chip in unbinned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/canabortexposure": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates whether the camera can abort exposures.", - "description": "\r\nReturns true if the camera can abort exposures; false if not.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/canasymmetricbin": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates whether the camera supports asymmetric binning", - "description": "\r\nReturns a flag showing whether this camera supports asymmetric binning", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/canfastreadout": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates whether the camera has a fast readout mode.", - "description": "\r\nIndicates whether the camera has a fast readout mode.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/cangetcoolerpower": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates whether the camera's cooler power setting can be read.", - "description": "\r\nIf true, the camera's cooler power setting can be read.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/canpulseguide": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns a flag indicating whether this camera supports pulse guiding", - "description": "\r\nReturns a flag indicating whether this camera supports pulse guiding.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/cansetccdtemperature": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns a flag indicating whether this camera supports setting the CCD temperature", - "description": "\r\nReturns a flag indicatig whether this camera supports setting the CCD temperature", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/canstopexposure": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns a flag indicating whether this camera can stop an exposure that is in progress", - "description": "\r\nReturns a flag indicating whether this camera can stop an exposure that is in progress", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/ccdtemperature": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current CCD temperature", - "description": "\r\nReturns the current CCD temperature in degrees Celsius.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/cooleron": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current cooler on/off state.", - "description": "\r\nReturns the current cooler on/off state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Turns the camera cooler on and off", - "description": "\r\nTurns on and off the camera cooler. True = cooler on, False = cooler off", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "CoolerOn" - ], - "type": "object", - "properties": { - "CoolerOn": { - "type": "boolean", - "description": "Cooler state" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "CoolerOn": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/coolerpower": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the present cooler power level", - "description": "\r\nReturns the present cooler power level, in percent.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/electronsperadu": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the gain of the camera", - "description": "\r\nReturns the gain of the camera in photoelectrons per A/D unit.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/exposuremax": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the maximum exposure time supported by StartExposure.", - "description": "\r\nReturns the maximum exposure time supported by StartExposure.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/exposuremin": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the Minimum exposure time", - "description": "\r\nReturns the Minimum exposure time in seconds that the camera supports through StartExposure.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/exposureresolution": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the smallest increment in exposure time supported by StartExposure.", - "description": "\r\nReturns the smallest increment in exposure time supported by StartExposure.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/fastreadout": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns whether Fast Readout Mode is enabled.", - "description": "\r\nReturns whether Fast Readout Mode is enabled", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets whether Fast Readout Mode is enabled.", - "description": "\r\nSets whether Fast Readout Mode is enabled.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "FastReadout" - ], - "type": "object", - "properties": { - "FastReadout": { - "type": "boolean", - "description": "True to enable fast readout mode" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "FastReadout": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/fullwellcapacity": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Reports the full well capacity of the camera", - "description": "\r\nReports the full well capacity of the camera in electrons, at the current camera settings (binning, SetupDialog settings, etc.).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/gain": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the camera's gain", - "description": "\r\nThe camera's gain (GAIN VALUE MODE) OR the index of the selected camera gain description in the Gains array (GAINS INDEX MODE).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the camera's gain.", - "description": "\r\nThe camera's gain (GAIN VALUE MODE) OR the index of the selected camera gain description in the Gains array (GAINS INDEX MODE).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Gain" - ], - "type": "object", - "properties": { - "Gain": { - "type": "integer", - "description": "Index of the current camera gain in the Gains string array.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Gain": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/gainmax": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Maximum Gain value of that this camera supports", - "description": "\r\nReturns the maximum value of Gain.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/gainmin": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Minimum Gain value of that this camera supports", - "description": "\r\nReturns the Minimum value of Gain", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/gains": { - "get": { - "tags": [ - "Camera" - ], - "summary": "List of Gain names supported by the camera", - "description": "\r\nReturns the Gains supported by the camera.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/hasshutter": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates whether the camera has a mechanical shutter", - "description": "\r\nReturns a flag indicating whether this camera has a mechanical shutter.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/heatsinktemperature": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current heat sink temperature.", - "description": "\r\nReturns the current heat sink temperature (called \"ambient temperature\" by some manufacturers) in degrees Celsius.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/imagearray": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns an array (2d or 3d of integers) containing the exposure pixel values", - "description": "\r\n\r\n Returns an array containing the pixel values from the last exposure.\r\n This call can return either a 2 dimension (monochrome images) or 3 dimension (colour or multi-plane images) array of size NumX * NumY or NumX * NumY * NumPlanes.\r\n Where applicable, the size of NumPlanes has to be determined by inspection of the returned Array.\r\n \r\n\r\n\r\n Since 32bit integers are always returned by this call, the returned JSON Type value (0 = Unknown, 1 = short(16bit), 2 = int(32bit), 3 = Double) is always 2. The number of planes is given in the returned Rank value.\r\n \r\n\r\n\r\n When de-serialising to an object it helps enormously to know the array Rank beforehand so that the correct data class can be used. This can be achieved through a regular expression or by direct parsing of the returned JSON string to extract the Type and Rank values before de-serialising.\r\n \r\n\r\n\r\n This regular expression accomplishes the extraction into two named groups Type and Rank, which can then be used to select the correct de-serialisation data class:\r\n \r\n\r\n\r\n ^*\"Type\":(?\\d*),\"Rank\":(?\\d*)\r\n \r\n\r\n\r\n When the SensorType is Monochrome, RGGB, CMYG, CMYG2 or LRGB, the serialised JSON array should have 2 dimensions. For example, the returned array should appear as below if NumX = 7, NumY = 5 and Pxy represents the pixel value at the zero based position x across and y down the image with the origin in the top left corner of the image. Please note that this is \"column-major\" order.\r\n \r\n\r\n\r\n [\r\n [P00, P01, P02, P03, P04],\r\n [P10, P11, P12, P13, P14],\r\n [P20, P21, P22, P23, P24],\r\n [P30, P31, P32, P33, P34],\r\n [P40, P41, P42, P43, P44],\r\n [P50, P51, P52, P53, P54],\r\n [P60, P61, P62, P63, P64]\r\n ]\r\n \r\n\r\n\r\n When the SensorType is Color, the serialised JSON array should have 3 dimensions.For example, the returned array should appear as below if NumX = 7, NumY = 5 and Rxy, Gxy and Bxy represent the red, green and blue pixel values at the zero based position x across and y down the image with the origin in the top left corner of the image.Please note that this is \"column-major\" order.\r\n \r\n\r\n\r\n [\r\n [[R00, G00, B00],[R01, G01, B01],[R02, G02, B02],[R03, G03, B03],[R04, G04, B04]],\r\n [[R10, G10, B10],[R11, G11, B11],[R12, G12, B12],[R13, G13, B13],[R14, G14, B14]],\r\n [[R20, G20, B20],[R21, G21, B21],[R22, G22, B22],[R23, G23, B23],[R24, G24, B24]],\r\n [[R30, G30, B30],[R31, G31, B31],[R32, G32, B32],[R33, G33, B33],[R34, G34, B34]],\r\n [[R40, G40, B40],[R41, G41, B41],[R42, G42, B42],[R43, G43, B43],[R44, G44, B44]],\r\n [[R50, G50, B50],[R51, G51, B51],[R52, G52, B52],[R53, G53, B53],[R54, G54, B54]],\r\n [[R60, G60, B60],[R61, G61, B61],[R62, G62, B62],[R63, G63, B63],[R64, G64, B64]],\r\n ]\r\n ", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntArray2DResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/imagearrayvariant": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns an array containing the exposure pixel values", - "description": "\r\n\r\n Returns an array containing the pixel values from the last exposure.\r\n This call can return either a 2 dimension (monochrome images) or 3 dimension (colour or multi-plane images) array of size NumX * NumY or NumX * NumY * NumPlanes.\r\n Where applicable, the size of NumPlanes has to be determined by inspection of the returned Array.\r\n \r\n\r\n\r\n This call can return values as short(16bit) integers, int(32bit) integers or double floating point values. The nature of the returned values is given in the Type parameter: 0 = Unknown, 1 = short(16bit), 2 = int(32bit), 3 = Double. The number of planes is given in the returned Rank value.\r\n \r\n\r\n\r\n When de-serialising to an object it helps enormously to know the array Rank beforehand so that the correct data class can be used. This can be achieved through a regular expression or by direct parsing of the returned JSON string to extract the Type and Rank values before de-serialising.\r\n \r\n\r\n\r\n This regular expression accomplishes the extraction into two named groups Type and Rank, which can then be used to select the correct de-serialisation data class:\r\n \r\n\r\n\r\n ^*\"Type\":(?\\d*),\"Rank\":(?\\d*)\r\n \r\n\r\n\r\n When the SensorType is Monochrome, RGGB, CMYG, CMYG2 or LRGB, the serialised JSON array should have 2 dimensions. For example, the returned array should appear as below if NumX = 7, NumY = 5 and Pxy represents the pixel value at the zero based position x across and y down the image with the origin in the top left corner of the image. Please note that this is \"column-major\" order.\r\n \r\n\r\n\r\n [\r\n [P00, P01, P02, P03, P04],\r\n [P10, P11, P12, P13, P14],\r\n [P20, P21, P22, P23, P24],\r\n [P30, P31, P32, P33, P34],\r\n [P40, P41, P42, P43, P44],\r\n [P50, P51, P52, P53, P54],\r\n [P60, P61, P62, P63, P64]\r\n ]\r\n \r\n\r\n\r\n When the SensorType is Color, the serialised JSON array should have 3 dimensions.For example, the returned array should appear as below if NumX = 7, NumY = 5 and Rxy, Gxy and Bxy represent the red, green and blue pixel values at the zero based position x across and y down the image with the origin in the top left corner of the image.Please note that this is \"column-major\" order.\r\n \r\n\r\n\r\n [\r\n [[R00, G00, B00],[R01, G01, B01],[R02, G02, B02],[R03, G03, B03],[R04, G04, B04]],\r\n [[R10, G10, B10],[R11, G11, B11],[R12, G12, B12],[R13, G13, B13],[R14, G14, B14]],\r\n [[R20, G20, B20],[R21, G21, B21],[R22, G22, B22],[R23, G23, B23],[R24, G24, B24]],\r\n [[R30, G30, B30],[R31, G31, B31],[R32, G32, B32],[R33, G33, B33],[R34, G34, B34]],\r\n [[R40, G40, B40],[R41, G41, B41],[R42, G42, B42],[R43, G43, B43],[R44, G44, B44]],\r\n [[R50, G50, B50],[R51, G51, B51],[R52, G52, B52],[R53, G53, B53],[R54, G54, B54]],\r\n [[R60, G60, B60],[R61, G61, B61],[R62, G62, B62],[R63, G63, B63],[R64, G64, B64]],\r\n ]\r\n ", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntArray2DResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/imageready": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates that an image is ready to be downloaded", - "description": "\r\nReturns a flag indicating whether the image is ready to be downloaded from the camera.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/ispulseguiding": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates that the camera is pulse guiding.", - "description": "\r\nReturns a flag indicating whether the camera is currently in a PulseGuide operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/lastexposureduration": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Duration of the last exposure", - "description": "\r\nReports the actual exposure duration in seconds (i.e. shutter open time).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/lastexposurestarttime": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Start time of the last exposure in FITS standard format.", - "description": "\r\nReports the actual exposure start in the FITS-standard CCYY-MM-DDThh:mm:ss[.sss...] format.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/maxadu": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Camera's maximum ADU value", - "description": "\r\nReports the maximum ADU value the camera can produce.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/maxbinx": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Maximum binning for the camera X axis", - "description": "\r\nReturns the maximum allowed binning for the X camera axis", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/maxbiny": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Maximum binning for the camera Y axis", - "description": "\r\nReturns the maximum allowed binning for the Y camera axis", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/numx": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current subframe width", - "description": "\r\nReturns the current subframe width, if binning is active, value is in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the current subframe width", - "description": "\r\nSets the current subframe width.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "NumX" - ], - "type": "object", - "properties": { - "NumX": { - "type": "integer", - "description": "Sets the subframe width, if binning is active, value is in binned pixels.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "NumX": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/numy": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current subframe height", - "description": "\r\nReturns the current subframe height, if binning is active, value is in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the current subframe height", - "description": "\r\nSets the current subframe height.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "NumY" - ], - "type": "object", - "properties": { - "NumY": { - "type": "integer", - "description": "Sets the subframe height, if binning is active, value is in binned pixels.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "NumY": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/offset": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the camera's offset", - "description": "\r\nReturns the camera's offset (OFFSET VALUE MODE) OR the index of the selected camera offset description in the offsets array (OFFSETS INDEX MODE).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the camera's offset.", - "description": "\r\nSets the camera's offset (OFFSET VALUE MODE) OR the index of the selected camera offset description in the offsets array (OFFSETS INDEX MODE).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Offset" - ], - "type": "object", - "properties": { - "Offset": { - "type": "integer", - "description": "Index of the current camera offset in the offsets string array.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Offset": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/offsetmax": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Maximum offset value of that this camera supports", - "description": "\r\nReturns the maximum value of offset.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/offsetmin": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Minimum offset value of that this camera supports", - "description": "\r\nReturns the Minimum value of offset.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/offsets": { - "get": { - "tags": [ - "Camera" - ], - "summary": "List of offset names supported by the camera", - "description": "\r\nReturns the offsets supported by the camera.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/percentcompleted": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates percentage completeness of the current operation", - "description": "\r\nReturns the percentage of the current operation that is complete. If valid, returns an integer between 0 and 100, where 0 indicates 0% progress (function just started) and 100 indicates 100% progress (i.e. completion).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/pixelsizex": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Width of CCD chip pixels (microns)", - "description": "\r\nReturns the width of the CCD chip pixels in microns.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/pixelsizey": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Height of CCD chip pixels (microns)", - "description": "\r\nReturns the Height of the CCD chip pixels in microns.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/readoutmode": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates the camera's readout mode as an index into the array ReadoutModes", - "description": "\r\nReadoutMode is an index into the array ReadoutModes and returns the desired readout mode for the camera. Defaults to 0 if not set.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Set the camera's readout mode", - "description": "\r\nSets the ReadoutMode as an index into the array ReadoutModes.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "ReadoutMode" - ], - "type": "object", - "properties": { - "ReadoutMode": { - "type": "integer", - "description": "Index into the ReadoutModes array of string readout mode names indicating the camera's current readout mode.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ReadoutMode": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/readoutmodes": { - "get": { - "tags": [ - "Camera" - ], - "summary": "List of available readout modes", - "description": "\r\nThis property provides an array of strings, each of which describes an available readout mode of the camera. At least one string must be present in the list.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/sensorname": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Sensor name", - "description": "\r\nThe name of the sensor used within the camera.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/sensortype": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Type of information returned by the the camera sensor (monochrome or colour)", - "description": "\r\nReturns a value indicating whether the sensor is monochrome, or what Bayer matrix it encodes. Where:\r\n\r\n0 = Monochrome,\r\n\r\n1 = Colour not requiring Bayer decoding\r\n\r\n2 = RGGB Bayer encoding\r\n\r\n3 = CMYG Bayer encoding\r\n\r\n4 = CMYG2 Bayer encoding\r\n\r\n5 = LRGB TRUESENSE Bayer encoding.\r\n\r\nPlease see the ASCOM Help fie for more information on the SensorType.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/setccdtemperature": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current camera cooler setpoint in degrees Celsius.", - "description": "\r\nReturns the current camera cooler setpoint in degrees Celsius.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Set the camera's cooler setpoint (degrees Celsius).", - "description": "\r\nSet's the camera's cooler setpoint in degrees Celsius.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SetCCDTemperature" - ], - "type": "object", - "properties": { - "SetCCDTemperature": { - "type": "number", - "description": "Temperature set point(degrees Celsius).", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SetCCDTemperature": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/startx": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Return the current subframe X axis start position", - "description": "\r\nSets the subframe start position for the X axis (0 based) and returns the current value. If binning is active, value is in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the current subframe X axis start position", - "description": "\r\nSets the current subframe X axis start position in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "StartX" - ], - "type": "object", - "properties": { - "StartX": { - "type": "integer", - "description": "The subframe X axis start position in binned pixels.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "StartX": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/starty": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Return the current subframe Y axis start position", - "description": "\r\nSets the subframe start position for the Y axis (0 based) and returns the current value. If binning is active, value is in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the current subframe Y axis start position", - "description": "\r\nSets the current subframe Y axis start position in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "StartY" - ], - "type": "object", - "properties": { - "StartY": { - "type": "integer", - "description": "The subframe Y axis start position in binned pixels.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "StartY": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/subexposureduration": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Camera's sub-exposure interval", - "description": "\r\nThe Camera's sub exposure duration in seconds. Only available in Camera Interface Version 3 and later.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the current Sub Exposure Duration", - "description": "\r\nSets image sub exposure duration in seconds. Only available in Camera Interface Version 3 and later.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SubExposureDuration" - ], - "type": "object", - "properties": { - "SubExposureDuration": { - "type": "number", - "description": "The request sub exposure duration in seconds", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SubExposureDuration": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/abortexposure": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Aborts the current exposure", - "description": "\r\nAborts the current exposure, if any, and returns the camera to Idle state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/pulseguide": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Aborts the current exposure", - "description": "\r\nAborts the current exposure, if any, and returns the camera to Idle state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Direction", - "Duration" - ], - "type": "object", - "properties": { - "Direction": { - "$ref": "#/components/schemas/GuideDirection" - }, - "Duration": { - "type": "integer", - "description": "Duration of movement in milli-seconds", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Direction": { - "style": "form" - }, - "Duration": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/startexposure": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Starts an exposure", - "description": "\r\nStarts an exposure. Use ImageReady to check when the exposure is complete.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Duration", - "Light" - ], - "type": "object", - "properties": { - "Duration": { - "type": "number", - "description": "Duration of exposure in seconds", - "format": "double" - }, - "Light": { - "type": "boolean", - "description": "True if light frame, false if dark frame." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Duration": { - "style": "form" - }, - "Light": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/stopexposure": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Stops the current exposure", - "description": "\r\nStops the current exposure, if any. If an exposure is in progress, the readout process is initiated. Ignored if readout is already in process.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/connect": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/action": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Invokes the specified device-specific action.", - "description": "\r\nActions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n\r\n\r\n\r\nThe key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n\r\n\r\n\r\nThe Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n\r\n\r\n\r\nThis capability will be of primary value to\r\n\r\n\r\n\r\n * bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n\r\n * a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n\r\n\r\n\r\nThe list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n\r\n\r\n\r\nThis method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "\r\nTransmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Retrieves the connected state of the device", - "description": "\r\nRetrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the connected state of the device", - "description": "\r\nSets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/description": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Device description", - "description": "\r\nThe description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Device driver description", - "description": "\r\nThe description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Driver Version", - "description": "\r\nA string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Camera" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/name": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Device name", - "description": "\r\nThe name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "\r\nReturns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/brightness": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the current calibrator brightness", - "description": "\r\nReturns the current calibrator brightness in the range 0 (completely off) to MaxBrightness (fully on)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/calibratorchanging": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "True while the calibrator brightness is not stable.", - "description": "\r\nTrue if the calibrator is stabilising after being set to a new brightness, otherwise False.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/calibratorstate": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the state of the calibration device", - "description": "\r\nReturns the state of the calibration device, if present, otherwise returns \"NotPresent\". The calibrator state mode is specified as an integer value from the CalibratorStatus Enum.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/covermoving": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "True while the cover is moving.", - "description": "\r\nTrue while the cover is moving to its new position after an OpenCover or CloseCover command.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/coverstate": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the state of the device cover", - "description": "\r\nReturns the state of the device cover, if present, otherwise returns \"NotPresent\". The cover state mode is specified as an integer value from the CoverStatus Enum.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/maxbrightness": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the calibrator's maximum Brightness value.", - "description": "\r\nThe Brightness value that makes the calibrator deliver its maximum illumination.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/calibratoroff": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Turns the calibrator off", - "description": "\r\nTurns the calibrator off if the device has calibration capability.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/calibratoron": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Turns the calibrator on at the specified brightness", - "description": "\r\nTurns the calibrator on at the specified brightness if the device has calibration capability.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Brightness" - ], - "type": "object", - "properties": { - "Brightness": { - "type": "integer", - "description": "The required brightness in the range 0 to MaxBrightness", - "format": "int32", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Brightness": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/closecover": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Initiates cover closing", - "description": "\r\nInitiates cover closing if a cover is present.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/haltcover": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Stops any cover movement that may be in progress", - "description": "\r\nStops any cover movement that may be in progress if a cover is present and cover movement can be interrupted.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/opencover": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Initiates cover opening", - "description": "\r\nInitiates cover opening if a cover is present.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/connect": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/action": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Invokes the specified device-specific action.", - "description": "\r\nActions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n\r\n\r\n\r\nThe key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n\r\n\r\n\r\nThe Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n\r\n\r\n\r\nThis capability will be of primary value to\r\n\r\n\r\n\r\n * bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n\r\n * a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n\r\n\r\n\r\nThe list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n\r\n\r\n\r\nThis method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "\r\nTransmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/connected": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Retrieves the connected state of the device", - "description": "\r\nRetrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Sets the connected state of the device", - "description": "\r\nSets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/description": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Device description", - "description": "\r\nThe description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Device driver description", - "description": "\r\nThe description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Driver Version", - "description": "\r\nA string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/name": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Device name", - "description": "\r\nThe name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "\r\nReturns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/altitude": { - "get": { - "tags": [ - "Dome" - ], - "summary": "The dome altitude", - "description": "\r\nThe dome altitude (degrees, horizon zero and increasing positive to 90 zenith).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/athome": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome is in the home position.", - "description": "\r\nIndicates whether the dome is in the home position.\r\n This is normally used following a FindHome() operation.\r\n The value is reset with any azimuth slew operation that moves the dome away from the home position.\r\n AtHome may also become true during normal slew operations,\r\n if the dome passes through the home position and the dome controller hardware is capable of detecting that;\r\n or at the end of a slew operation if the dome comes to rest at the home position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/atpark": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome is at the park position", - "description": "\r\nTrue if the dome is in the programmed park position. Set only following a Park() operation and reset with any slew operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/azimuth": { - "get": { - "tags": [ - "Dome" - ], - "summary": "The dome azimuth", - "description": "\r\nReturns the dome azimuth (degrees, North zero and increasing clockwise, i.e., 90 East, 180 South, 270 West)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/canfindhome": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome can find the home position.", - "description": "\r\nTrue if the dome can move to the home position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/canpark": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome can be parked.", - "description": "\r\nTrue if the dome is capable of programmed parking (Park() method)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/cansetaltitude": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome altitude can be set", - "description": "\r\nTrue if driver is capable of setting the dome altitude.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/cansetazimuth": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome azimuth can be set", - "description": "\r\nTrue if driver is capable of setting the dome azimuth.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/cansetpark": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome park position can be set", - "description": "\r\nTrue if driver is capable of setting the dome park position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/cansetshutter": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome shutter can be opened", - "description": "\r\nTrue if driver is capable of automatically operating shutter", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/canslave": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome supports slaving to a telescope", - "description": "\r\nTrue if driver is capable of slaving to a telescope.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/cansyncazimuth": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome azimuth position can be synced", - "description": "\r\nTrue if driver is capable of synchronizing the dome azimuth position using the SyncToAzimuth(Double) method.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/shutterstatus": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Status of the dome shutter or roll-off roof", - "description": "\r\nReturns the status of the dome shutter or roll-off roof. 0 = Open, 1 = Closed, 2 = Opening, 3 = Closing, 4 = Shutter status error", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/slaved": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome is slaved to the telescope", - "description": "\r\nTrue if the dome is slaved to the telescope in its hardware, else False.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Dome" - ], - "summary": "Sets whether the dome is slaved to the telescope", - "description": "\r\nSets whether the dome is slaved to the telescope", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Slaved" - ], - "type": "object", - "properties": { - "Slaved": { - "type": "boolean", - "description": "True if telescope is slaved to dome, otherwise false" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Slaved": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/slewing": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the any part of the dome is moving", - "description": "\r\nTrue if any part of the dome is currently moving, False if all dome components are steady.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/abortslew": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Immediately cancel current dome operation.", - "description": "\r\nCalling this method will immediately disable hardware slewing (Slaved will become False).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/closeshutter": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Close the shutter or otherwise shield telescope from the sky.", - "description": "\r\nClose the shutter or otherwise shield telescope from the sky.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/findhome": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Start operation to search for the dome home position.", - "description": "\r\nAfter Home position is established initializes Azimuth to the default value and sets the AtHome flag.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/openshutter": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Open shutter or otherwise expose telescope to the sky.", - "description": "\r\nOpen shutter or otherwise expose telescope to the sky.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/park": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Rotate dome in azimuth to park position.", - "description": "\r\nAfter assuming programmed park position, sets AtPark flag.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/setpark": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Set the current azimuth, altitude position of dome to be the park position.", - "description": "\r\nSet the current azimuth, altitude position of dome to be the park position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/slewtoaltitude": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Slew the dome to the given altitude position.", - "description": "\r\nSlew the dome to the given altitude position", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Altitude" - ], - "type": "object", - "properties": { - "Altitude": { - "type": "number", - "description": "Target dome altitude (degrees, horizon zero and increasing positive to 90 zenith0", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Altitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/slewtoazimuth": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Slew the dome to the given azimuth position.", - "description": "\r\nSlew the dome to the given azimuth position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Azimuth" - ], - "type": "object", - "properties": { - "Azimuth": { - "type": "number", - "description": "Target dome azimuth (degrees, North zero and increasing clockwise. i.e., 90 East, 180 South, 270 West)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Azimuth": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/synctoazimuth": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Synchronize the dome to the given azimuth position.", - "description": "\r\nSynchronize the dome to the given azimuth position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Azimuth" - ], - "type": "object", - "properties": { - "Azimuth": { - "type": "number", - "description": "Target dome azimuth (degrees, North zero and increasing clockwise. i.e., 90 East, 180 South, 270 West)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Azimuth": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/connect": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/action": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Invokes the specified device-specific action.", - "description": "\r\nActions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n\r\n\r\n\r\nThe key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n\r\n\r\n\r\nThe Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n\r\n\r\n\r\nThis capability will be of primary value to\r\n\r\n\r\n\r\n * bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n\r\n * a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n\r\n\r\n\r\nThe list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n\r\n\r\n\r\nThis method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "\r\nTransmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Retrieves the connected state of the device", - "description": "\r\nRetrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Dome" - ], - "summary": "Sets the connected state of the device", - "description": "\r\nSets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/description": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Device description", - "description": "\r\nThe description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Device driver description", - "description": "\r\nThe description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Driver Version", - "description": "\r\nA string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Dome" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/name": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Device name", - "description": "\r\nThe name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "\r\nReturns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/focusoffsets": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Filter focus offsets", - "description": "\r\nAn integer array of filter focus offsets.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/names": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Filter wheel filter names", - "description": "\r\nThe names of the filters", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/position": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Returns the current filter wheel position", - "description": "\r\nReturns the current filter wheel position", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Sets the filter wheel position", - "description": "\r\nSets the filter wheel position", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "integer", - "description": "Sets the filter wheel position", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/connect": { - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/action": { - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Invokes the specified device-specific action.", - "description": "\r\nActions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n\r\n\r\n\r\nThe key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n\r\n\r\n\r\nThe Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n\r\n\r\n\r\nThis capability will be of primary value to\r\n\r\n\r\n\r\n * bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n\r\n * a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n\r\n\r\n\r\nThe list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n\r\n\r\n\r\nThis method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "\r\nTransmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/connected": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Retrieves the connected state of the device", - "description": "\r\nRetrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Sets the connected state of the device", - "description": "\r\nSets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/description": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Device description", - "description": "\r\nThe description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Device driver description", - "description": "\r\nThe description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Driver Version", - "description": "\r\nA string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/name": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Device name", - "description": "\r\nThe name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "\r\nReturns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/absolute": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Indicates whether the focuser is capable of absolute position.", - "description": "\r\nTrue if the focuser is capable of absolute position; that is, being commanded to a specific step location.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/ismoving": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Indicates whether the focuser is currently moving.", - "description": "\r\nTrue if the focuser is currently moving to a new position. False if the focuser is stationary.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/maxincrement": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the focuser's maximum increment size.", - "description": "\r\nMaximum increment size allowed by the focuser; i.e. the maximum number of steps allowed in one move operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/maxstep": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the focuser's maximum step size.", - "description": "\r\nMaximum step position permitted.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/position": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the focuser's current position.", - "description": "\r\nCurrent focuser position, in steps.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/stepsize": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the focuser's step size.", - "description": "\r\nStep size (microns) for the focuser.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/tempcomp": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Retrieves the state of temperature compensation mode", - "description": "\r\nGets the state of temperature compensation mode (if available), else always False.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Focuser" - ], - "summary": "Sets the device's temperature compensation mode.", - "description": "\r\nSets the state of temperature compensation mode.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "TempComp" - ], - "type": "object", - "properties": { - "TempComp": { - "type": "boolean", - "description": "Set true to enable the focuser's temperature compensation mode, otherwise false for normal operation." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "TempComp": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/tempcompavailable": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Indicates whether the focuser has temperature compensation.", - "description": "\r\nTrue if focuser has temperature compensation available.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/temperature": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the focuser's current temperature.", - "description": "\r\nCurrent ambient temperature as measured by the focuser.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/halt": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Immediately stops focuser motion.", - "description": "\r\nImmediately stop any focuser motion due to a previous Move(Int32) method call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/move": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Moves the focuser to a new position.", - "description": "\r\nMoves the focuser by the specified amount or to the specified position depending on the value of the Absolute property.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "integer", - "description": "Step distance or absolute position, depending on the value of the Absolute property", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/connect": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/action": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Invokes the specified device-specific action.", - "description": "\r\nActions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n\r\n\r\n\r\nThe key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n\r\n\r\n\r\nThe Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n\r\n\r\n\r\nThis capability will be of primary value to\r\n\r\n\r\n\r\n * bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n\r\n * a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n\r\n\r\n\r\nThe list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n\r\n\r\n\r\nThis method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "\r\nTransmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Retrieves the connected state of the device", - "description": "\r\nRetrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Focuser" - ], - "summary": "Sets the connected state of the device", - "description": "\r\nSets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/description": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Device description", - "description": "\r\nThe description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Device driver description", - "description": "\r\nThe description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Driver Version", - "description": "\r\nA string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/name": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Device name", - "description": "\r\nThe name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "\r\nReturns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/management/apiversions": { - "get": { - "tags": [ - "Management" - ], - "summary": "Supported Alpaca API versions", - "description": "\r\nReturns an integer array of supported Alpaca API version numbers.", - "parameters": [ - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/management/v1/description": { - "get": { - "tags": [ - "Management" - ], - "summary": "Summary information about this device as a whole", - "description": "\r\nSummary information about each available ASCOM device", - "parameters": [ - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AlpacaDescriptionResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/management/v1/configureddevices": { - "get": { - "tags": [ - "Management" - ], - "summary": "Summary information about each available ASCOM device", - "description": "\r\nReturns an array of device description objects, providing unique information for each served device, enabling them to be accessed through the Alpaca Device API.", - "parameters": [ - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AlpacaConfiguredDevicesResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/averageperiod": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the time period over which observations will be averaged", - "description": "\r\nGets the time period over which observations will be averaged", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Sets the time period over which observations will be averaged", - "description": "\r\nSets the time period over which observations will be averaged", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "AveragePeriod" - ], - "type": "object", - "properties": { - "AveragePeriod": { - "type": "number", - "description": "Time period(hours) over which to average sensor readings", - "format": "double", - "default": 1 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "AveragePeriod": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/cloudcover": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the amount of sky obscured by cloud", - "description": "\r\nGets the percentage of the sky obscured by cloud", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/dewpoint": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the atmospheric dew point at the observatory", - "description": "\r\nGets the atmospheric dew point at the observatory reported in °C.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/humidity": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the atmospheric humidity at the observatory", - "description": "\r\nGets the atmospheric humidity (%) at the observatory", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/pressure": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the atmospheric pressure at the observatory.", - "description": "\r\nGets the atmospheric pressure in hectoPascals at the observatory's altitude - NOT reduced to sea level.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/rainrate": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the rain rate at the observatory.", - "description": "\r\nGets the rain rate (mm/hour) at the observatory.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/skybrightness": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the sky brightness at the observatory", - "description": "\r\nGets the sky brightness at the observatory (Lux)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/skyquality": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the sky quality at the observatory", - "description": "\r\nGets the sky quality at the observatory (magnitudes per square arc second)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/skytemperature": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the sky temperature at the observatory", - "description": "\r\nGets the sky temperature(°C) at the observatory.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/starfwhm": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the seeing at the observatory", - "description": "\r\nGets the seeing at the observatory measured as star full width half maximum (FWHM) in arc secs.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/temperature": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the temperature at the observatory", - "description": "\r\nGets the temperature(°C) at the observatory.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/winddirection": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the wind direction at the observatory", - "description": "\r\nGets the wind direction. The returned value must be between 0.0 and 360.0, interpreted according to the metereological standard, where a special value of 0.0 is returned when the wind speed is 0.0. Wind direction is measured clockwise from north, through east, where East=90.0, South=180.0, West=270.0 and North=360.0.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/windgust": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the peak 3 second wind gust at the observatory over the last 2 minutes", - "description": "\r\nGets the peak 3 second wind gust(m/s) at the observatory over the last 2 minutes.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/windspeed": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the wind speed at the observatory.", - "description": "\r\nGets the wind speed(m/s) at the observatory.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/refresh": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Refreshes sensor values from hardware.", - "description": "\r\nForces the driver to immediately query its attached hardware to refresh sensor values.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/sensordescription": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Return a sensor description", - "description": "\r\nGets a description of the sensor with the name specified in the SensorName parameter", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "SensorName", - "in": "query", - "description": "Name of the sensor whose description is required", - "required": true, - "schema": { - "type": "string", - "description": "Name of the sensor whose description is required" - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/timesincelastupdate": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Return the time since the sensor value was last updated", - "description": "\r\nGets the time since the sensor specified in the SensorName parameter was last updated", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "SensorName", - "in": "query", - "description": "Name of the sensor whose description is required", - "schema": { - "type": "string", - "description": "Name of the sensor whose description is required", - "default": "" - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/connect": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/action": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Invokes the specified device-specific action.", - "description": "\r\nActions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n\r\n\r\n\r\nThe key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n\r\n\r\n\r\nThe Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n\r\n\r\n\r\nThis capability will be of primary value to\r\n\r\n\r\n\r\n * bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n\r\n * a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n\r\n\r\n\r\nThe list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n\r\n\r\n\r\nThis method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "\r\nTransmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/connected": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Retrieves the connected state of the device", - "description": "\r\nRetrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Sets the connected state of the device", - "description": "\r\nSets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/description": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Device description", - "description": "\r\nThe description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Device driver description", - "description": "\r\nThe description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Driver Version", - "description": "\r\nA string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/name": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Device name", - "description": "\r\nThe name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "\r\nReturns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/canreverse": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Indicates whether the Rotator supports the Reverse method.", - "description": "\r\nTrue if the Rotator supports the Reverse method.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/ismoving": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Indicates whether the rotator is currently moving.", - "description": "\r\nTrue if the rotator is currently moving to a new position. False if the focuser is stationary.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/mechanicalposition": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the rotator’s Reverse state.", - "description": "\r\nReturns the rotator’s Reverse state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/position": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the rotator's current position.", - "description": "\r\nCurrent instantaneous Rotator position, in degrees.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/reverse": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the rotator’s Reverse state.", - "description": "\r\nReturns the rotator’s Reverse state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Rotator" - ], - "summary": "Sets the rotator’s Reverse state.", - "description": "\r\nSets the rotator’s Reverse state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Reverse" - ], - "type": "object", - "properties": { - "Reverse": { - "type": "boolean", - "description": "True if the rotation and angular direction must be reversed to match the optical characteristcs" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Reverse": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/stepsize": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the minimum StepSize", - "description": "\r\nThe minimum StepSize, in degrees.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/targetposition": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the destination position angle.", - "description": "\r\nThe destination position angle for Move() and MoveAbsolute().", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/halt": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Immediately stops rotator motion.", - "description": "\r\nImmediately stop any Rotator motion due to a previous Move or MoveAbsolute method call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/move": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Moves the rotator to a new relative position.", - "description": "\r\nCauses the rotator to move Position degrees relative to the current Position value.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "number", - "description": "Relative position to move in degrees from current Position.", - "format": "double", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/moveabsolute": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Moves the rotator to a new absolute position.", - "description": "\r\nCauses the rotator to move the absolute position of Position degrees.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "number", - "description": "Absolute position in degrees.", - "format": "double", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/movemechanical": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Moves the rotator to a new raw mechanical position.", - "description": "\r\nCauses the rotator to move the mechanical position of Position degrees.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "number", - "description": "Absolute position in degrees.", - "format": "double", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/sync": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Syncs the rotator to the specified position angle without moving it.", - "description": "\r\nCauses the rotator to sync to the position of Position degrees.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "number", - "description": "Absolute position in degrees.", - "format": "double", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/connect": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/action": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Invokes the specified device-specific action.", - "description": "\r\nActions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n\r\n\r\n\r\nThe key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n\r\n\r\n\r\nThe Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n\r\n\r\n\r\nThis capability will be of primary value to\r\n\r\n\r\n\r\n * bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n\r\n * a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n\r\n\r\n\r\nThe list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n\r\n\r\n\r\nThis method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "\r\nTransmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Retrieves the connected state of the device", - "description": "\r\nRetrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Rotator" - ], - "summary": "Sets the connected state of the device", - "description": "\r\nSets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/description": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Device description", - "description": "\r\nThe description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Device driver description", - "description": "\r\nThe description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Driver Version", - "description": "\r\nA string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/name": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Device name", - "description": "\r\nThe name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "\r\nReturns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/issafe": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Indicates whether the monitored state is safe for use.", - "description": "\r\nIndicates whether the monitored state is safe for use. True if the state is safe, False if it is unsafe.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/connect": { - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/action": { - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Invokes the specified device-specific action.", - "description": "\r\nActions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n\r\n\r\n\r\nThe key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n\r\n\r\n\r\nThe Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n\r\n\r\n\r\nThis capability will be of primary value to\r\n\r\n\r\n\r\n * bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n\r\n * a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n\r\n\r\n\r\nThe list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n\r\n\r\n\r\nThis method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "\r\nTransmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/connected": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Retrieves the connected state of the device", - "description": "\r\nRetrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Sets the connected state of the device", - "description": "\r\nSets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/description": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Device description", - "description": "\r\nThe description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Device driver description", - "description": "\r\nThe description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Driver Version", - "description": "\r\nA string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/name": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Device name", - "description": "\r\nThe name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "\r\nReturns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/camera/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/covercalibrator/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/dome/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/filterwheel/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/focuser/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/observingconditions/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/rotator/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/safetymonitor/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/switch/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/telescope/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/camera/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/covercalibrator/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/dome/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/filterwheel/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/focuser/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/observingconditions/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/rotator/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/safetymonitor/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/switch/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/telescope/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/camera/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/covercalibrator/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/dome/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/filterwheel/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/focuser/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/observingconditions/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/rotator/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/safetymonitor/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/switch/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/telescope/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/maxswitch": { - "get": { - "tags": [ - "Switch" - ], - "summary": "The number of switch devices managed by this driver", - "description": "\r\nReturns the number of switch devices managed by this driver. Devices are numbered from 0 to MaxSwitch - 1", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/canwrite": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Indicates whether the specified switch device can be written to", - "description": "\r\nReports if the specified switch device can be written to, default true. This is false if the device cannot be written to, for example a limit switch or a sensor. Devices are numbered from 0 to MaxSwitch - 1", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "Id", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/getswitch": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Return the state of switch device id as a boolean", - "description": "\r\nReturn the state of switch device id as a boolean. Devices are numbered from 0 to MaxSwitch - 1", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "Id", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/getswitchdescription": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Gets the description of the specified switch device", - "description": "\r\nGets the description of the specified switch device. This is to allow a fuller description of the device to be returned, for example for a tool tip. Devices are numbered from 0 to MaxSwitch - 1", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "Id", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/getswitchname": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Gets the name of the specified switch device", - "description": "\r\nGets the name of the specified switch device. Devices are numbered from 0 to MaxSwitch - 1", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "Id", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/getswitchvalue": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Gets the value of the specified switch device as a double", - "description": "\r\nGets the value of the specified switch device as a double. Devices are numbered from 0 to MaxSwitch - 1, The value of this switch is expected to be between MinSwitchValue and MaxSwitchValue.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "Id", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/minswitchvalue": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Gets the minimum value of the specified switch device as a double", - "description": "\r\nGets the minimum value of the specified switch device as a double. Devices are numbered from 0 to MaxSwitch - 1.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "Id", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/maxswitchvalue": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Gets the maximum value of the specified switch device as a double", - "description": "\r\nGets the maximum value of the specified switch device as a double. Devices are numbered from 0 to MaxSwitch - 1.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "Id", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/switchstep": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Returns the step size that this device supports (the difference between successive values of the device).", - "description": "\r\nReturns the step size that this device supports (the difference between successive values of the device). Devices are numbered from 0 to MaxSwitch - 1.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "Id", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/setswitch": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Sets a switch controller device to the specified state, true or false", - "description": "\r\nSets a switch controller device to the specified state, true or false.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Id", - "State" - ], - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "The device number (0 to MaxSwitch - 1)", - "format": "int32", - "default": 0 - }, - "State": { - "type": "boolean", - "description": "The required control state(True or False)" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Id": { - "style": "form" - }, - "State": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/setswitchname": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Sets a switch device name to the specified value", - "description": "\r\nSets a switch device name to the specified value.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Id", - "Name" - ], - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "The device number (0 to MaxSwitch - 1)", - "format": "int32", - "default": 0 - }, - "Name": { - "type": "string", - "description": "The name of the device" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Id": { - "style": "form" - }, - "Name": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/setswitchvalue": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Sets a switch device value to the specified value", - "description": "\r\nSets a switch device value to the specified value.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Id", - "Value" - ], - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "The device number (0 to MaxSwitch - 1)", - "format": "int32", - "default": 0 - }, - "Value": { - "type": "number", - "description": "The value to be set, between MinSwitchValue and MaxSwitchValue", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Id": { - "style": "form" - }, - "Value": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/canasync": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Flag indicating whether this switch can operate asynchronously.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "Id", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/statechangecomplete": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Completion variable for asynchronous changes.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "Id", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/cancelasync": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Cancels an in-progress asynchronous operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Id" - ], - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "The device number (0 to MaxSwitch - 1)", - "format": "int32", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Id": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/setasync": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Set a boolean switch's state asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Id", - "State" - ], - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "The device number (0 to MaxSwitch - 1)", - "format": "int32", - "default": 0 - }, - "State": { - "type": "boolean", - "description": "The required control state(True or False)" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Id": { - "style": "form" - }, - "State": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/setasyncvalue": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Set a switch's value asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Id", - "Value" - ], - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "The device number (0 to MaxSwitch - 1)", - "format": "int32", - "default": 0 - }, - "Value": { - "type": "number", - "description": "The value to be set, between MinSwitchValue and MaxSwitchValue", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Id": { - "style": "form" - }, - "Value": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/connect": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/action": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Invokes the specified device-specific action.", - "description": "\r\nActions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n\r\n\r\n\r\nThe key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n\r\n\r\n\r\nThe Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n\r\n\r\n\r\nThis capability will be of primary value to\r\n\r\n\r\n\r\n * bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n\r\n * a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n\r\n\r\n\r\nThe list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n\r\n\r\n\r\nThis method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "\r\nTransmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Retrieves the connected state of the device", - "description": "\r\nRetrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Switch" - ], - "summary": "Sets the connected state of the device", - "description": "\r\nSets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/description": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Device description", - "description": "\r\nThe description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Device driver description", - "description": "\r\nThe description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Driver Version", - "description": "\r\nA string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Switch" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/name": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Device name", - "description": "\r\nThe name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "\r\nReturns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/abortslew": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Immediately stops a slew in progress.", - "description": "\r\nImmediately Stops a slew in progress.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/alignmentmode": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current mount alignment mode", - "description": "\r\nReturns the alignment mode of the mount (Alt/Az, Polar, German Polar). The alignment mode is specified as an integer value from the AlignmentModes Enum.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/altitude": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the mount's altitude above the horizon.", - "description": "\r\nThe altitude above the local horizon of the mount's current position (degrees, positive up)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/aperturearea": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the telescope's aperture.", - "description": "\r\nThe area of the telescope's aperture, taking into account any obstructions (square meters)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/aperturediameter": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the telescope's effective aperture.", - "description": "\r\nThe telescope's effective aperture diameter (meters)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/athome": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the mount is at the home position.", - "description": "\r\nTrue if the mount is stopped in the Home position. Set only following a FindHome() operation, and reset with any slew operation. This property must be False if the telescope does not support homing.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/atpark": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope is at the park position.", - "description": "\r\nTrue if the telescope has been put into the parked state by the see Park() method. Set False by calling the Unpark() method.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/axisrates": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the rates at which the telescope may be moved about the specified axis.", - "description": "\r\nThe rates at which the telescope may be moved about the specified axis by the MoveAxis(TelescopeAxes, Double) method.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "Axis", - "in": "query", - "description": "The axis about which rate information is desired. 0 = axisPrimary, 1 = axisSecondary, 2 = axisTertiary.", - "required": true, - "schema": { - "$ref": "#/components/schemas/TelescopeAxis" - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AxisRatesResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/azimuth": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the mount's azimuth.", - "description": "\r\nThe azimuth at the local horizon of the mount's current position (degrees, North-referenced, positive East/clockwise).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canfindhome": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the mount can find the home position.", - "description": "\r\nTrue if this telescope is capable of programmed finding its home position (FindHome() method).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canmoveaxis": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can move the requested axis.", - "description": "\r\nTrue if this telescope can move the requested axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "Axis", - "in": "query", - "description": "The axis about which rate information is desired. 0 = axisPrimary, 1 = axisSecondary, 2 = axisTertiary.", - "required": true, - "schema": { - "$ref": "#/components/schemas/TelescopeAxis" - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canpark": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can be parked.", - "description": "\r\nTrue if this telescope is capable of programmed parking (Park() method)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canpulseguide": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can be pulse guided.", - "description": "\r\nTrue if this telescope is capable of software-pulsed guiding (via the PulseGuide(GuideDirections, Int32) method)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansetdeclinationrate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the DeclinationRate property can be changed.", - "description": "\r\nTrue if the DeclinationRate property can be changed to provide offset tracking in the declination axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansetguiderates": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the Guide Rates can be changed.", - "description": "\r\nTrue if the guide rate properties used for PulseGuide(GuideDirections, Int32) can be adjusted.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansetpark": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope park position can be set.", - "description": "\r\nTrue if this telescope is capable of programmed setting of its park position (SetPark() method)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansetpierside": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope SideOfPier can be set.", - "description": "\r\nTrue if the SideOfPier property can be set, meaning that the mount can be forced to flip.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansetrightascensionrate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the RightAscensionRate property can be changed.", - "description": "\r\nTrue if the RightAscensionRate property can be changed to provide offset tracking in the right ascension axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansettracking": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the Tracking property can be changed.", - "description": "\r\nTrue if the Tracking property can be changed, turning telescope sidereal tracking on and off.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canslew": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can slew synchronously.", - "description": "\r\nTrue if this telescope is capable of programmed slewing (synchronous or asynchronous) to equatorial coordinates", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canslewaltaz": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can slew synchronously to AltAz coordinates.", - "description": "\r\nTrue if this telescope is capable of programmed slewing (synchronous or asynchronous) to local horizontal coordinates", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canslewaltazasync": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can slew asynchronously to AltAz coordinates.", - "description": "\r\nTrue if this telescope is capable of programmed asynchronous slewing to local horizontal coordinates", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canslewasync": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can slew asynchronously.", - "description": "\r\nTrue if this telescope is capable of programmed asynchronous slewing to equatorial coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansync": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can sync to equatorial coordinates.", - "description": "\r\nTrue if this telescope is capable of programmed syncing to equatorial coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansyncaltaz": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can sync to local horizontal coordinates.", - "description": "\r\nTrue if this telescope is capable of programmed syncing to local horizontal coordinates", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canunpark": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can be unparked.", - "description": "\r\nTrue if this telescope is capable of programmed unparking (Unpark() method)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/declination": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the mount's declination.", - "description": "\r\nThe declination (degrees) of the mount's current equatorial coordinates, in the coordinate system given by the EquatorialSystem property. Reading the property will raise an error if the value is unavailable.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/declinationrate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the telescope's declination tracking rate.", - "description": "\r\nThe declination tracking rate (arcseconds per SI second, default = 0.0). Please note that rightascensionrate units are arcseconds per sidereal second.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the telescope's declination tracking rate.", - "description": "\r\nSets the declination tracking rate (arcseconds per SI second). Please note that rightascensionrate units are arcseconds per sidereal second.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "DeclinationRate" - ], - "type": "object", - "properties": { - "DeclinationRate": { - "type": "number", - "description": "Declination tracking rate (arcseconds per SI second). Please note that rightascensionrate units are arcseconds per sidereal second.", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "DeclinationRate": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/destinationsideofpier": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Predicts the pointing state after a German equatorial mount slews to given coordinates.", - "description": "\r\nPredicts the pointing state that a German equatorial mount will be in if it slews to the given coordinates. The return value will be one of - 0 = pierEast, 1 = pierWest, -1 = pierUnknown", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "RightAscension", - "in": "query", - "description": "Right Ascension coordinate (0.0 to 23.99999999 hours)", - "required": true, - "schema": { - "type": "number", - "description": "Right Ascension coordinate (0.0 to 23.99999999 hours)", - "format": "double" - } - }, - { - "name": "Declination", - "in": "query", - "description": "Declination coordinate (-90.0 to +90.0 degrees)", - "required": true, - "schema": { - "type": "number", - "description": "Declination coordinate (-90.0 to +90.0 degrees)", - "format": "double" - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/doesrefraction": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether atmospheric refraction is applied to coordinates.", - "description": "\r\nTrue if the telescope or driver applies atmospheric refraction to coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Determines whether atmospheric refraction is applied to coordinates.", - "description": "\r\nDetermines whether atmospheric refraction is applied to coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "DoesRefraction" - ], - "type": "object", - "properties": { - "DoesRefraction": { - "type": "boolean", - "description": "Determines whether atmospheric refraction is applied to coordinates." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "DoesRefraction": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/equatorialsystem": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current equatorial coordinate system used by this telescope.", - "description": "\r\nReturns the current equatorial coordinate system used by this telescope (e.g. Topocentric or J2000).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/findhome": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Moves the mount to the \"home\" position.", - "description": "\r\nLocates the telescope's \"home\" position (synchronous)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/focallength": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the telescope's focal length in meters.", - "description": "\r\nThe telescope's focal length in meters", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/guideratedeclination": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Sets the current Declination rate offset for telescope guiding.", - "description": "\r\nThe current Declination movement rate offset for telescope guiding (degrees/sec)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current Declination rate offset for telescope guiding", - "description": "\r\nSets the current Declination movement rate offset for telescope guiding (degrees/sec).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "GuideRateDeclination" - ], - "type": "object", - "properties": { - "GuideRateDeclination": { - "type": "number", - "description": "Declination movement rate offset degrees/sec).", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "GuideRateDeclination": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/guideraterightascension": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current RightAscension rate offset for telescope guiding", - "description": "\r\nThe current RightAscension movement rate offset for telescope guiding (degrees/sec)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the current RightAscension rate offset for telescope guiding.", - "description": "\r\nSets the current RightAscension movement rate offset for telescope guiding (degrees/sec).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "GuideRateRightAscension" - ], - "type": "object", - "properties": { - "GuideRateRightAscension": { - "type": "number", - "description": "RightAscension movement rate offset (degrees/sec).", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "GuideRateRightAscension": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/ispulseguiding": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope is currently executing a PulseGuide command", - "description": "\r\nTrue if a PulseGuide(GuideDirections, Int32) command is in progress, False otherwise", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/moveaxis": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Moves a telescope axis at the given rate.", - "description": "\r\nMove the telescope in one axis at the given rate.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Axis", - "Rate" - ], - "type": "object", - "properties": { - "Axis": { - "$ref": "#/components/schemas/TelescopeAxis" - }, - "Rate": { - "type": "number", - "description": "The rate of motion (deg/sec) about the specified axis", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Axis": { - "style": "form" - }, - "Rate": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/park": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Park the mount", - "description": "\r\nMove the telescope to its park position, stop all motion (or restrict to a small safe range), and set AtPark to True.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/pulseguide": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Moves the scope in the given direction for the given time.", - "description": "\r\nMoves the scope in the given direction for the given interval or time at the rate given by the corresponding guide rate property", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Direction", - "Duration" - ], - "type": "object", - "properties": { - "Direction": { - "$ref": "#/components/schemas/GuideDirection" - }, - "Duration": { - "type": "integer", - "description": "The duration of the guide-rate motion (milliseconds)", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Direction": { - "style": "form" - }, - "Duration": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/rightascension": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the mount's right ascension coordinate.", - "description": "\r\nThe right ascension (hours) of the mount's current equatorial coordinates, in the coordinate system given by the EquatorialSystem property", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/rightascensionrate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the telescope's right ascension tracking rate.", - "description": "\r\nThe right ascension tracking rate (arcseconds per sidereal second, default = 0.0). Please note that the declinationrate units are arcseconds per SI second.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the telescope's right ascension tracking rate.", - "description": "\r\nSets the right ascension tracking rate (arcseconds per sidereal second). Please note that the declinationrate units are arcseconds per SI second.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "RightAscensionRate" - ], - "type": "object", - "properties": { - "RightAscensionRate": { - "type": "number", - "description": "Right ascension tracking rate (arcseconds per sideral second). Please note that the declinationrate units are arcseconds per SI second.", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "RightAscensionRate": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/setpark": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the telescope's park position", - "description": "\r\nSets the telescope's park position to be its current position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/sideofpier": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the mount's pointing state.", - "description": "\r\nIndicates the pointing state of the mount. 0 = pierEast, 1 = pierWest, -1= pierUnknown", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the mount's pointing state.", - "description": "\r\nSets the pointing state of the mount. 0 = pierEast, 1 = pierWest", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SideOfPier" - ], - "type": "object", - "properties": { - "SideOfPier": { - "$ref": "#/components/schemas/PointingState" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SideOfPier": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/siderealtime": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the local apparent sidereal time.", - "description": "\r\nThe local apparent sidereal time from the telescope's internal clock (hours, sidereal).The local apparent sidereal time from the telescope's internal clock (hours, sidereal).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/siteelevation": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the observing site's elevation above mean sea level.", - "description": "\r\nThe elevation above mean sea level (meters) of the site at which the telescope is located.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the observing site's elevation above mean sea level.", - "description": "\r\nSets the elevation above mean sea level (metres) of the site at which the telescope is located.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SiteElevation" - ], - "type": "object", - "properties": { - "SiteElevation": { - "type": "number", - "description": "Elevation above mean sea level (metres).", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SiteElevation": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/sitelatitude": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the observing site's latitude.", - "description": "\r\nThe geodetic(map) latitude (degrees, positive North, WGS84) of the site at which the telescope is located.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the observing site's latitude.", - "description": "\r\nSets the observing site's latitude (degrees).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SiteLatitude" - ], - "type": "object", - "properties": { - "SiteLatitude": { - "type": "number", - "description": "Site latitude (degrees)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SiteLatitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/sitelongitude": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the observing site's longitude.", - "description": "\r\nThe longitude (degrees, positive East, WGS84) of the site at which the telescope is located.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the observing site's longitude.", - "description": "\r\nSets the observing site's longitude (degrees, positive East, WGS84).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SiteLongitude" - ], - "type": "object", - "properties": { - "SiteLongitude": { - "type": "number", - "description": "Site longitude (degrees, positive East, WGS84)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SiteLongitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewing": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope is currently slewing.", - "description": "\r\nTrue if telescope is currently moving in response to one of the Slew methods or the MoveAxis(TelescopeAxes, Double) method, False at all other times.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewsettletime": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the post-slew settling time.", - "description": "\r\nReturns the post-slew settling time (sec.).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the post-slew settling time.", - "description": "\r\nSets the post-slew settling time (integer sec.).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SlewSettleTime" - ], - "type": "object", - "properties": { - "SlewSettleTime": { - "type": "integer", - "description": "Settling time (integer sec.).", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SlewSettleTime": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtoaltaz": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Synchronously slew to the given local horizontal coordinates.", - "description": "\r\nMove the telescope to the given local horizontal coordinates, return when slew is complete", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Altitude", - "Azimuth" - ], - "type": "object", - "properties": { - "Azimuth": { - "type": "number", - "description": "Azimuth coordinate (degrees, North-referenced, positive East/clockwise)", - "format": "double" - }, - "Altitude": { - "type": "number", - "description": "Altitude coordinate (degrees, positive up)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Azimuth": { - "style": "form" - }, - "Altitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtoaltazasync": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Asynchronously slew to the given local horizontal coordinates.", - "description": "\r\nMove the telescope to the given local horizontal coordinates, return immediately after the slew starts. The client can poll the Slewing method to determine when the mount reaches the intended coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Altitude", - "Azimuth" - ], - "type": "object", - "properties": { - "Azimuth": { - "type": "number", - "description": "Azimuth coordinate (degrees, North-referenced, positive East/clockwise)", - "format": "double" - }, - "Altitude": { - "type": "number", - "description": "Altitude coordinate (degrees, positive up)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Azimuth": { - "style": "form" - }, - "Altitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtocoordinates": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Synchronously slew to the given equatorial coordinates.", - "description": "\r\nMove the telescope to the given equatorial coordinates, return when slew is complete", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Declination", - "RightAscension" - ], - "type": "object", - "properties": { - "RightAscension": { - "type": "number", - "description": "Right Ascension coordinate (hours)", - "format": "double" - }, - "Declination": { - "type": "number", - "description": "Declination coordinate (degrees)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "RightAscension": { - "style": "form" - }, - "Declination": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtocoordinatesasync": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Synchronously slew to the given equatorial coordinates.", - "description": "\r\nMove the telescope to the given equatorial coordinates, return when slew is complete", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Declination", - "RightAscension" - ], - "type": "object", - "properties": { - "RightAscension": { - "type": "number", - "description": "Right Ascension coordinate (hours)", - "format": "double" - }, - "Declination": { - "type": "number", - "description": "Declination coordinate (degrees)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "RightAscension": { - "style": "form" - }, - "Declination": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtotarget": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Synchronously slew to the TargetRightAscension and TargetDeclination coordinates.", - "description": "\r\nMove the telescope to the TargetRightAscension and TargetDeclination equatorial coordinates, return when slew is complete", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtotargetasync": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Asynchronously slew to the TargetRightAscension and TargetDeclination coordinates.", - "description": "\r\nMove the telescope to the TargetRightAscension and TargetDeclination equatorial coordinates, return immediatley after the slew starts. The client can poll the Slewing method to determine when the mount reaches the intended coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/synctoaltaz": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Syncs to the given local horizontal coordinates.", - "description": "\r\nMatches the scope's local horizontal coordinates to the given local horizontal coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Altitude", - "Azimuth" - ], - "type": "object", - "properties": { - "Azimuth": { - "type": "number", - "description": "Azimuth coordinate (degrees, North-referenced, positive East/clockwise)", - "format": "double" - }, - "Altitude": { - "type": "number", - "description": "Altitude coordinate (degrees, positive up)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Azimuth": { - "style": "form" - }, - "Altitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/synctocoordinates": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Syncs to the given equatorial coordinates.", - "description": "\r\nMatches the scope's equatorial coordinates to the given equatorial coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Declination", - "RightAscension" - ], - "type": "object", - "properties": { - "RightAscension": { - "type": "number", - "description": "Right Ascension coordinate (hours)", - "format": "double" - }, - "Declination": { - "type": "number", - "description": "Declination coordinate (degrees)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "RightAscension": { - "style": "form" - }, - "Declination": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/synctotarget": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Syncs to the TargetRightAscension and TargetDeclination coordinates.", - "description": "\r\nMatches the scope's equatorial coordinates to the TargetRightAscension and TargetDeclination equatorial coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/targetdeclination": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current target declination.", - "description": "\r\nThe declination (degrees, positive North) for the target of an equatorial slew or sync operation", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the target declination of a slew or sync.", - "description": "\r\nSets the declination (degrees, positive North) for the target of an equatorial slew or sync operation", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "TargetDeclination" - ], - "type": "object", - "properties": { - "TargetDeclination": { - "type": "number", - "description": "Target declination(degrees)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "TargetDeclination": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/targetrightascension": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current target right ascension.", - "description": "\r\nThe right ascension (hours) for the target of an equatorial slew or sync operation", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the target right ascension of a slew or sync.", - "description": "\r\nSets the right ascension (hours) for the target of an equatorial slew or sync operation", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "TargetRightAscension" - ], - "type": "object", - "properties": { - "TargetRightAscension": { - "type": "number", - "description": "Target right ascension(hours)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "TargetRightAscension": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/tracking": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope is tracking.", - "description": "\r\nReturns the state of the telescope's sidereal tracking drive.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Enables or disables telescope tracking.", - "description": "\r\nSets the state of the telescope's sidereal tracking drive.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Tracking" - ], - "type": "object", - "properties": { - "Tracking": { - "type": "boolean", - "description": "Tracking enabled / disabled" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Tracking": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/trackingrate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current tracking rate.", - "description": "\r\nThe current tracking rate of the telescope's sidereal drive.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the mount's tracking rate.", - "description": "\r\nSets the tracking rate of the telescope's sidereal drive. 0 = driveSidereal, 1 = driveLunar, 2 = driveSolar, 3 = driveKing", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "TrackingRate" - ], - "type": "object", - "properties": { - "TrackingRate": { - "type": "integer", - "description": "New tracking rate", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "TrackingRate": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/trackingrates": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns a collection of supported DriveRates values.", - "description": "\r\nReturns an array of supported DriveRates values that describe the permissible values of the TrackingRate property for this telescope type.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DriveRatesResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/utcdate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the UTC date/time of the telescope's internal clock.", - "description": "\r\nThe UTC date/time of the telescope's internal clock in ISO 8601 format including fractional seconds. The general format (in Microsoft custom date format style) is yyyy-MM-ddTHH:mm:ss.fffffffZ E.g. 2016-03-04T17:45:31.1234567Z or 2016-11-14T07:03:08.1234567Z Please note the compulsory trailing Z indicating the 'Zulu', UTC time zone.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the UTC date/time of the telescope's internal clock.", - "description": "\r\nThe UTC date/time of the telescope's internal clock in ISO 8601 format including fractional seconds. The general format (in Microsoft custom date format style) is yyyy-MM-ddTHH:mm:ss.fffffffZ E.g. 2016-03-04T17:45:31.1234567Z or 2016-11-14T07:03:08.1234567Z Please note the compulsory trailing Z indicating the 'Zulu', UTC time zone.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "UTCDate" - ], - "type": "object", - "properties": { - "UTCDate": { - "type": "string", - "description": "UTC date/time in ISO 8601 format.", - "format": "date-time" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "UTCDate": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/unpark": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Unparks the mount.", - "description": "\r\nTakes telescope out of the Parked state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/connect": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/action": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Invokes the specified device-specific action.", - "description": "\r\nActions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n\r\n\r\n\r\nThe key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n\r\n\r\n\r\nThe Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n\r\n\r\n\r\nThis capability will be of primary value to\r\n\r\n\r\n\r\n * bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n\r\n * a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n\r\n\r\n\r\nThe list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n\r\n\r\n\r\nThis method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "\r\nTransmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "\r\nTransmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Retrieves the connected state of the device", - "description": "\r\nRetrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the connected state of the device", - "description": "\r\nSets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/description": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Device description", - "description": "\r\nThe description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Device driver description", - "description": "\r\nThe description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Driver Version", - "description": "\r\nA string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "\r\nThis method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/name": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Device name", - "description": "\r\nThe name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "\r\nReturns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - } - }, - "components": { - "schemas": { - "AlpacaConfiguredDevice": { - "type": "object", - "properties": { - "DeviceName": { - "type": "string", - "description": "A short name for this device that a user would expect to see in a list of available devices.", - "nullable": true - }, - "DeviceType": { - "type": "string", - "description": "One of the supported ASCOM Devices types such as Telescope, Camera, Focuser etc.", - "nullable": true - }, - "DeviceNumber": { - "type": "integer", - "description": "The device number that must be used to access this device through the Alpaca Device API.", - "format": "int32" - }, - "UniqueID": { - "type": "string", - "description": "\"This should be the ProgID for COM devices or a GUID for native Alpaca devices.\"", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Returns an array of device description objects, providing unique information for each served device, enabling them to be accessed through the Alpaca Device API." - }, - "AlpacaConfiguredDevicesResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AlpacaConfiguredDevice" - }, - "description": "AlpacaConfiguredDevicesResponse value returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Class representing an Alpaca device's configured devices response" - }, - "AlpacaDescriptionResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "$ref": "#/components/schemas/AlpacaDeviceDescription" - } - }, - "additionalProperties": false, - "description": "The response for the AlpacaDeviceDescription" - }, - "AlpacaDeviceDescription": { - "type": "object", - "properties": { - "ServerName": { - "type": "string", - "description": "The device or server's overall name.", - "nullable": true - }, - "Manufacturer": { - "type": "string", - "description": "The manufacturer's name.", - "nullable": true - }, - "ManufacturerVersion": { - "type": "string", - "description": "The device or server's version number.", - "nullable": true - }, - "Location": { - "type": "string", - "description": "The device or server's location.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Returns cross-cutting information that applies to all devices available at this URL:Port." - }, - "AlpacaErrors": { - "enum": [ - 0, - 1024, - 1025, - 1026, - 1031, - 1032, - 1033, - 1035, - 1036, - 1038, - 1279, - 1280, - 4095 - ], - "type": "integer", - "description": "Error numbers for use by Alpaca applications and drivers in the range 0x400 to 0xFFF.", - "format": "int32" - }, - "ArrayType": { - "enum": [ - 0, - 1, - 2, - 3 - ], - "type": "integer", - "description": "Image array element type enumeration", - "format": "int32" - }, - "Assembly": { - "type": "object", - "properties": { - "DefinedTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TypeInfo" - }, - "nullable": true, - "readOnly": true - }, - "ExportedTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - }, - "CodeBase": { - "type": "string", - "nullable": true, - "readOnly": true, - "deprecated": true - }, - "EntryPoint": { - "$ref": "#/components/schemas/MethodInfo" - }, - "FullName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "ImageRuntimeVersion": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "IsDynamic": { - "type": "boolean", - "readOnly": true - }, - "Location": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "ReflectionOnly": { - "type": "boolean", - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "IsFullyTrusted": { - "type": "boolean", - "readOnly": true - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "EscapedCodeBase": { - "type": "string", - "nullable": true, - "readOnly": true, - "deprecated": true - }, - "ManifestModule": { - "$ref": "#/components/schemas/Module" - }, - "Modules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Module" - }, - "nullable": true, - "readOnly": true - }, - "GlobalAssemblyCache": { - "type": "boolean", - "readOnly": true, - "deprecated": true - }, - "HostContext": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "SecurityRuleSet": { - "$ref": "#/components/schemas/SecurityRuleSet" - } - }, - "additionalProperties": false - }, - "AxisRate": { - "type": "object", - "properties": { - "Minimum": { - "type": "number", - "description": "The minimum rate (degrees per second) This must always be a positive number. It indicates the maximum rate in either direction about the axis.", - "format": "double" - }, - "Maximum": { - "type": "number", - "description": "The maximum rate (degrees per second) This must always be a positive number. It indicates the maximum rate in either direction about the axis.", - "format": "double" - } - }, - "additionalProperties": false, - "description": "Describe a rate at which the telescope may be moved about the specified axis by the MoveAxis(TelescopeAxes, Double) method." - }, - "AxisRatesResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AxisRate" - }, - "description": "Axis rate collection returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a collection of ASCOM.Common.DeviceInterfaces.AxisRate values." - }, - "BoolResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "boolean", - "description": "Boolean value returned by the device" - } - }, - "additionalProperties": false, - "description": "Alpaca boolean response class" - }, - "CallingConventions": { - "enum": [ - 1, - 2, - 3, - 32, - 64 - ], - "type": "integer", - "format": "int32" - }, - "ConstructorInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "Attributes": { - "$ref": "#/components/schemas/MethodAttributes" - }, - "MethodImplementationFlags": { - "$ref": "#/components/schemas/MethodImplAttributes" - }, - "CallingConvention": { - "$ref": "#/components/schemas/CallingConventions" - }, - "IsAbstract": { - "type": "boolean", - "readOnly": true - }, - "IsConstructor": { - "type": "boolean", - "readOnly": true - }, - "IsFinal": { - "type": "boolean", - "readOnly": true - }, - "IsHideBySig": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsStatic": { - "type": "boolean", - "readOnly": true - }, - "IsVirtual": { - "type": "boolean", - "readOnly": true - }, - "IsAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamily": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyAndAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyOrAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsConstructedGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethodDefinition": { - "type": "boolean", - "readOnly": true - }, - "ContainsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "MethodHandle": { - "$ref": "#/components/schemas/RuntimeMethodHandle" - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - } - }, - "additionalProperties": false - }, - "CustomAttributeData": { - "type": "object", - "properties": { - "AttributeType": { - "$ref": "#/components/schemas/Type" - }, - "Constructor": { - "$ref": "#/components/schemas/ConstructorInfo" - }, - "ConstructorArguments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeTypedArgument" - }, - "nullable": true, - "readOnly": true - }, - "NamedArguments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeNamedArgument" - }, - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false - }, - "CustomAttributeNamedArgument": { - "type": "object", - "properties": { - "MemberInfo": { - "$ref": "#/components/schemas/MemberInfo" - }, - "TypedValue": { - "$ref": "#/components/schemas/CustomAttributeTypedArgument" - }, - "MemberName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "IsField": { - "type": "boolean", - "readOnly": true - } - }, - "additionalProperties": false - }, - "CustomAttributeTypedArgument": { - "type": "object", - "properties": { - "ArgumentType": { - "$ref": "#/components/schemas/Type" - }, - "Value": { - "nullable": true - } - }, - "additionalProperties": false - }, - "DeviceStateResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateValue" - }, - "description": "IStateValue collection returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a collection of IStateValue objects" - }, - "DoubleResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "number", - "description": "Double value returned by the device", - "format": "double" - } - }, - "additionalProperties": false, - "description": "Response that returns a double value." - }, - "DriveRate": { - "enum": [ - 0, - 1, - 2, - 3 - ], - "type": "integer", - "description": "Well-known telescope tracking rates.", - "format": "int32" - }, - "DriveRatesResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DriveRate" - }, - "description": "Drive rate collection returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a collection of ASCOM.Common.DeviceInterfaces.DriveRate values" - }, - "EventAttributes": { - "enum": [ - 0, - 512, - 1024 - ], - "type": "integer", - "format": "int32" - }, - "EventInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Attributes": { - "$ref": "#/components/schemas/EventAttributes" - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "AddMethod": { - "$ref": "#/components/schemas/MethodInfo" - }, - "RemoveMethod": { - "$ref": "#/components/schemas/MethodInfo" - }, - "RaiseMethod": { - "$ref": "#/components/schemas/MethodInfo" - }, - "IsMulticast": { - "type": "boolean", - "readOnly": true - }, - "EventHandlerType": { - "$ref": "#/components/schemas/Type" - } - }, - "additionalProperties": false - }, - "Exception": { - "type": "object", - "properties": { - "TargetSite": { - "$ref": "#/components/schemas/MethodBase" - }, - "Message": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "Data": { - "type": "object", - "additionalProperties": { }, - "nullable": true, - "readOnly": true - }, - "InnerException": { - "$ref": "#/components/schemas/Exception" - }, - "HelpLink": { - "type": "string", - "nullable": true - }, - "Source": { - "type": "string", - "nullable": true - }, - "HResult": { - "type": "integer", - "format": "int32" - }, - "StackTrace": { - "type": "string", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false - }, - "FieldAttributes": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 5, - 6, - 7, - 16, - 32, - 64, - 128, - 256, - 512, - 1024, - 4096, - 8192, - 32768, - 38144 - ], - "type": "integer", - "format": "int32" - }, - "FieldInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Attributes": { - "$ref": "#/components/schemas/FieldAttributes" - }, - "FieldType": { - "$ref": "#/components/schemas/Type" - }, - "IsInitOnly": { - "type": "boolean", - "readOnly": true - }, - "IsLiteral": { - "type": "boolean", - "readOnly": true - }, - "IsNotSerialized": { - "type": "boolean", - "readOnly": true, - "deprecated": true - }, - "IsPinvokeImpl": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsStatic": { - "type": "boolean", - "readOnly": true - }, - "IsAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamily": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyAndAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyOrAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "FieldHandle": { - "$ref": "#/components/schemas/RuntimeFieldHandle" - } - }, - "additionalProperties": false - }, - "GenericParameterAttributes": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 8, - 16, - 28 - ], - "type": "integer", - "format": "int32" - }, - "GuideDirection": { - "enum": [ - 0, - 1, - 2, - 3 - ], - "type": "integer", - "description": "The direction in which the guide-rate motion is to be made.", - "format": "int32" - }, - "ICustomAttributeProvider": { - "type": "object", - "additionalProperties": false - }, - "IntArray2DResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Type": { - "$ref": "#/components/schemas/ArrayType" - }, - "Rank": { - "type": "integer", - "description": "The array's rank, will be 2 (single plane image (monochrome)).", - "format": "int32", - "readOnly": true - }, - "Value": { - "type": "array", - "items": { }, - "description": "2D image array of int32 values", - "nullable": true - } - }, - "additionalProperties": false, - "description": "2 dimension image array response" - }, - "IntListResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "Integer collection returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a collection of integer values." - }, - "IntPtr": { - "type": "object", - "additionalProperties": false - }, - "IntResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "integer", - "description": "Integer value returned by the device", - "format": "int32" - } - }, - "additionalProperties": false, - "description": "Response that returns an integer value." - }, - "LayoutKind": { - "enum": [ - 0, - 2, - 3 - ], - "type": "integer", - "format": "int32" - }, - "MemberInfo": { - "type": "object", - "properties": { - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "additionalProperties": false - }, - "MemberTypes": { - "enum": [ - 1, - 2, - 4, - 8, - 16, - 32, - 64, - 128, - 191 - ], - "type": "integer", - "format": "int32" - }, - "MethodAttributes": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 5, - 6, - 7, - 8, - 16, - 32, - 64, - 128, - 256, - 512, - 1024, - 2048, - 4096, - 8192, - 16384, - 32768, - 53248 - ], - "type": "integer", - "format": "int32" - }, - "MethodBase": { - "type": "object", - "properties": { - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "Attributes": { - "$ref": "#/components/schemas/MethodAttributes" - }, - "MethodImplementationFlags": { - "$ref": "#/components/schemas/MethodImplAttributes" - }, - "CallingConvention": { - "$ref": "#/components/schemas/CallingConventions" - }, - "IsAbstract": { - "type": "boolean", - "readOnly": true - }, - "IsConstructor": { - "type": "boolean", - "readOnly": true - }, - "IsFinal": { - "type": "boolean", - "readOnly": true - }, - "IsHideBySig": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsStatic": { - "type": "boolean", - "readOnly": true - }, - "IsVirtual": { - "type": "boolean", - "readOnly": true - }, - "IsAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamily": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyAndAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyOrAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsConstructedGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethodDefinition": { - "type": "boolean", - "readOnly": true - }, - "ContainsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "MethodHandle": { - "$ref": "#/components/schemas/RuntimeMethodHandle" - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - } - }, - "additionalProperties": false - }, - "MethodImplAttributes": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 8, - 16, - 32, - 64, - 128, - 256, - 512, - 4096, - 65535 - ], - "type": "integer", - "format": "int32" - }, - "MethodInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "Attributes": { - "$ref": "#/components/schemas/MethodAttributes" - }, - "MethodImplementationFlags": { - "$ref": "#/components/schemas/MethodImplAttributes" - }, - "CallingConvention": { - "$ref": "#/components/schemas/CallingConventions" - }, - "IsAbstract": { - "type": "boolean", - "readOnly": true - }, - "IsConstructor": { - "type": "boolean", - "readOnly": true - }, - "IsFinal": { - "type": "boolean", - "readOnly": true - }, - "IsHideBySig": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsStatic": { - "type": "boolean", - "readOnly": true - }, - "IsVirtual": { - "type": "boolean", - "readOnly": true - }, - "IsAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamily": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyAndAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyOrAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsConstructedGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethodDefinition": { - "type": "boolean", - "readOnly": true - }, - "ContainsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "MethodHandle": { - "$ref": "#/components/schemas/RuntimeMethodHandle" - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "ReturnParameter": { - "$ref": "#/components/schemas/ParameterInfo" - }, - "ReturnType": { - "$ref": "#/components/schemas/Type" - }, - "ReturnTypeCustomAttributes": { - "$ref": "#/components/schemas/ICustomAttributeProvider" - } - }, - "additionalProperties": false - }, - "Module": { - "type": "object", - "properties": { - "Assembly": { - "$ref": "#/components/schemas/Assembly" - }, - "FullyQualifiedName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "MDStreamVersion": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "ModuleVersionId": { - "type": "string", - "format": "uuid", - "readOnly": true - }, - "ScopeName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "ModuleHandle": { - "$ref": "#/components/schemas/ModuleHandle" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "additionalProperties": false - }, - "ModuleHandle": { - "type": "object", - "properties": { - "MDStreamVersion": { - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "additionalProperties": false - }, - "ParameterAttributes": { - "enum": [ - 0, - 1, - 2, - 4, - 8, - 16, - 4096, - 8192, - 16384, - 32768, - 61440 - ], - "type": "integer", - "format": "int32" - }, - "ParameterInfo": { - "type": "object", - "properties": { - "Attributes": { - "$ref": "#/components/schemas/ParameterAttributes" - }, - "Member": { - "$ref": "#/components/schemas/MemberInfo" - }, - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "ParameterType": { - "$ref": "#/components/schemas/Type" - }, - "Position": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "IsIn": { - "type": "boolean", - "readOnly": true - }, - "IsLcid": { - "type": "boolean", - "readOnly": true - }, - "IsOptional": { - "type": "boolean", - "readOnly": true - }, - "IsOut": { - "type": "boolean", - "readOnly": true - }, - "IsRetval": { - "type": "boolean", - "readOnly": true - }, - "DefaultValue": { - "nullable": true, - "readOnly": true - }, - "RawDefaultValue": { - "nullable": true, - "readOnly": true - }, - "HasDefaultValue": { - "type": "boolean", - "readOnly": true - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "additionalProperties": false - }, - "PointingState": { - "enum": [ - 0, - 1, - -1 - ], - "type": "integer", - "description": "The pointing state of the mount", - "format": "int32" - }, - "PropertyAttributes": { - "enum": [ - 0, - 512, - 1024, - 4096, - 8192, - 16384, - 32768, - 62464 - ], - "type": "integer", - "format": "int32" - }, - "PropertyInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "PropertyType": { - "$ref": "#/components/schemas/Type" - }, - "Attributes": { - "$ref": "#/components/schemas/PropertyAttributes" - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "CanRead": { - "type": "boolean", - "readOnly": true - }, - "CanWrite": { - "type": "boolean", - "readOnly": true - }, - "GetMethod": { - "$ref": "#/components/schemas/MethodInfo" - }, - "SetMethod": { - "$ref": "#/components/schemas/MethodInfo" - } - }, - "additionalProperties": false - }, - "Response": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - } - }, - "additionalProperties": false, - "description": "Defines the properties that are common to all Alpaca responses." - }, - "RuntimeFieldHandle": { - "type": "object", - "properties": { - "Value": { - "$ref": "#/components/schemas/IntPtr" - } - }, - "additionalProperties": false - }, - "RuntimeMethodHandle": { - "type": "object", - "properties": { - "Value": { - "$ref": "#/components/schemas/IntPtr" - } - }, - "additionalProperties": false - }, - "RuntimeTypeHandle": { - "type": "object", - "properties": { - "Value": { - "$ref": "#/components/schemas/IntPtr" - } - }, - "additionalProperties": false - }, - "SecurityRuleSet": { - "enum": [ - 0, - 1, - 2 - ], - "type": "integer", - "format": "int32" - }, - "StateValue": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "description": "State name", - "nullable": true - }, - "Value": { - "description": "State value", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Class to hold a state name:value pair." - }, - "StringListResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "array", - "items": { - "type": "string" - }, - "description": "String collection returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a collection of strings" - }, - "StringResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "string", - "description": "String value returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a string value" - }, - "StructLayoutAttribute": { - "type": "object", - "properties": { - "TypeId": { - "nullable": true, - "readOnly": true - }, - "Value": { - "$ref": "#/components/schemas/LayoutKind" - } - }, - "additionalProperties": false - }, - "TelescopeAxis": { - "enum": [ - 0, - 1, - 2 - ], - "type": "integer", - "description": "The telescope axes", - "format": "int32" - }, - "Type": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "IsInterface": { - "type": "boolean", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Namespace": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "AssemblyQualifiedName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "FullName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "Assembly": { - "$ref": "#/components/schemas/Assembly" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "IsNested": { - "type": "boolean", - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "DeclaringMethod": { - "$ref": "#/components/schemas/MethodBase" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "UnderlyingSystemType": { - "$ref": "#/components/schemas/Type" - }, - "IsTypeDefinition": { - "type": "boolean", - "readOnly": true - }, - "IsArray": { - "type": "boolean", - "readOnly": true - }, - "IsByRef": { - "type": "boolean", - "readOnly": true - }, - "IsPointer": { - "type": "boolean", - "readOnly": true - }, - "IsConstructedGenericType": { - "type": "boolean", - "readOnly": true - }, - "IsGenericParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericTypeParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethodParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericType": { - "type": "boolean", - "readOnly": true - }, - "IsGenericTypeDefinition": { - "type": "boolean", - "readOnly": true - }, - "IsSZArray": { - "type": "boolean", - "readOnly": true - }, - "IsVariableBoundArray": { - "type": "boolean", - "readOnly": true - }, - "IsByRefLike": { - "type": "boolean", - "readOnly": true - }, - "IsFunctionPointer": { - "type": "boolean", - "readOnly": true - }, - "IsUnmanagedFunctionPointer": { - "type": "boolean", - "readOnly": true - }, - "HasElementType": { - "type": "boolean", - "readOnly": true - }, - "GenericTypeArguments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - }, - "GenericParameterPosition": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "GenericParameterAttributes": { - "$ref": "#/components/schemas/GenericParameterAttributes" - }, - "Attributes": { - "$ref": "#/components/schemas/TypeAttributes" - }, - "IsAbstract": { - "type": "boolean", - "readOnly": true - }, - "IsImport": { - "type": "boolean", - "readOnly": true - }, - "IsSealed": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsClass": { - "type": "boolean", - "readOnly": true - }, - "IsNestedAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamANDAssem": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamily": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamORAssem": { - "type": "boolean", - "readOnly": true - }, - "IsNestedPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsNestedPublic": { - "type": "boolean", - "readOnly": true - }, - "IsNotPublic": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsAutoLayout": { - "type": "boolean", - "readOnly": true - }, - "IsExplicitLayout": { - "type": "boolean", - "readOnly": true - }, - "IsLayoutSequential": { - "type": "boolean", - "readOnly": true - }, - "IsAnsiClass": { - "type": "boolean", - "readOnly": true - }, - "IsAutoClass": { - "type": "boolean", - "readOnly": true - }, - "IsUnicodeClass": { - "type": "boolean", - "readOnly": true - }, - "IsCOMObject": { - "type": "boolean", - "readOnly": true - }, - "IsContextful": { - "type": "boolean", - "readOnly": true - }, - "IsEnum": { - "type": "boolean", - "readOnly": true - }, - "IsMarshalByRef": { - "type": "boolean", - "readOnly": true - }, - "IsPrimitive": { - "type": "boolean", - "readOnly": true - }, - "IsValueType": { - "type": "boolean", - "readOnly": true - }, - "IsSignatureType": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "StructLayoutAttribute": { - "$ref": "#/components/schemas/StructLayoutAttribute" - }, - "TypeInitializer": { - "$ref": "#/components/schemas/ConstructorInfo" - }, - "TypeHandle": { - "$ref": "#/components/schemas/RuntimeTypeHandle" - }, - "GUID": { - "type": "string", - "format": "uuid", - "readOnly": true - }, - "BaseType": { - "$ref": "#/components/schemas/Type" - }, - "IsSerializable": { - "type": "boolean", - "readOnly": true, - "deprecated": true - }, - "ContainsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "IsVisible": { - "type": "boolean", - "readOnly": true - } - }, - "additionalProperties": false - }, - "TypeAttributes": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 5, - 6, - 7, - 8, - 16, - 24, - 32, - 128, - 256, - 1024, - 2048, - 4096, - 8192, - 16384, - 65536, - 131072, - 196608, - 262144, - 264192, - 1048576, - 12582912 - ], - "type": "integer", - "format": "int32" - }, - "TypeInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "IsInterface": { - "type": "boolean", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Namespace": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "AssemblyQualifiedName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "FullName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "Assembly": { - "$ref": "#/components/schemas/Assembly" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "IsNested": { - "type": "boolean", - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "DeclaringMethod": { - "$ref": "#/components/schemas/MethodBase" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "UnderlyingSystemType": { - "$ref": "#/components/schemas/Type" - }, - "IsTypeDefinition": { - "type": "boolean", - "readOnly": true - }, - "IsArray": { - "type": "boolean", - "readOnly": true - }, - "IsByRef": { - "type": "boolean", - "readOnly": true - }, - "IsPointer": { - "type": "boolean", - "readOnly": true - }, - "IsConstructedGenericType": { - "type": "boolean", - "readOnly": true - }, - "IsGenericParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericTypeParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethodParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericType": { - "type": "boolean", - "readOnly": true - }, - "IsGenericTypeDefinition": { - "type": "boolean", - "readOnly": true - }, - "IsSZArray": { - "type": "boolean", - "readOnly": true - }, - "IsVariableBoundArray": { - "type": "boolean", - "readOnly": true - }, - "IsByRefLike": { - "type": "boolean", - "readOnly": true - }, - "IsFunctionPointer": { - "type": "boolean", - "readOnly": true - }, - "IsUnmanagedFunctionPointer": { - "type": "boolean", - "readOnly": true - }, - "HasElementType": { - "type": "boolean", - "readOnly": true - }, - "GenericTypeArguments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - }, - "GenericParameterPosition": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "GenericParameterAttributes": { - "$ref": "#/components/schemas/GenericParameterAttributes" - }, - "Attributes": { - "$ref": "#/components/schemas/TypeAttributes" - }, - "IsAbstract": { - "type": "boolean", - "readOnly": true - }, - "IsImport": { - "type": "boolean", - "readOnly": true - }, - "IsSealed": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsClass": { - "type": "boolean", - "readOnly": true - }, - "IsNestedAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamANDAssem": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamily": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamORAssem": { - "type": "boolean", - "readOnly": true - }, - "IsNestedPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsNestedPublic": { - "type": "boolean", - "readOnly": true - }, - "IsNotPublic": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsAutoLayout": { - "type": "boolean", - "readOnly": true - }, - "IsExplicitLayout": { - "type": "boolean", - "readOnly": true - }, - "IsLayoutSequential": { - "type": "boolean", - "readOnly": true - }, - "IsAnsiClass": { - "type": "boolean", - "readOnly": true - }, - "IsAutoClass": { - "type": "boolean", - "readOnly": true - }, - "IsUnicodeClass": { - "type": "boolean", - "readOnly": true - }, - "IsCOMObject": { - "type": "boolean", - "readOnly": true - }, - "IsContextful": { - "type": "boolean", - "readOnly": true - }, - "IsEnum": { - "type": "boolean", - "readOnly": true - }, - "IsMarshalByRef": { - "type": "boolean", - "readOnly": true - }, - "IsPrimitive": { - "type": "boolean", - "readOnly": true - }, - "IsValueType": { - "type": "boolean", - "readOnly": true - }, - "IsSignatureType": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "StructLayoutAttribute": { - "$ref": "#/components/schemas/StructLayoutAttribute" - }, - "TypeInitializer": { - "$ref": "#/components/schemas/ConstructorInfo" - }, - "TypeHandle": { - "$ref": "#/components/schemas/RuntimeTypeHandle" - }, - "GUID": { - "type": "string", - "format": "uuid", - "readOnly": true - }, - "BaseType": { - "$ref": "#/components/schemas/Type" - }, - "IsSerializable": { - "type": "boolean", - "readOnly": true, - "deprecated": true - }, - "ContainsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "IsVisible": { - "type": "boolean", - "readOnly": true - }, - "GenericTypeParameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredConstructors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConstructorInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredEvents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EventInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FieldInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredMembers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MemberInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MethodInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredNestedTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TypeInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredProperties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyInfo" - }, - "nullable": true, - "readOnly": true - }, - "ImplementedInterfaces": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false - } - } - } -} \ No newline at end of file diff --git a/templates/AlpacaDeviceAPI_v2_plat7.json b/templates/AlpacaDeviceAPI_v2_plat7.json deleted file mode 100644 index e0bbc3e..0000000 --- a/templates/AlpacaDeviceAPI_v2_plat7.json +++ /dev/null @@ -1,36252 +0,0 @@ -{ - "openapi": "3.0.1", - "info": { - "title": "ASCOM Alpaca Simulators", - "description": "Please note that the Alpaca API documentation on the ASCOM website is the canonical version. There are several issues with this auto generated version that will be resolved in future versions. This is currently provided only for testing..", - "version": "v0" - }, - "paths": { - "/api/v1/camera/{DeviceNumber}/bayeroffsetx": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the X offset of the Bayer matrix.", - "description": "
Returns the X offset of the Bayer matrix, as defined in SensorType.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/bayeroffsety": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the Y offset of the Bayer matrix.", - "description": "
Returns the Y offset of the Bayer matrix, as defined in SensorType.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/binx": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the binning factor for the X axis.", - "description": "
Returns the binning factor for the X axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the binning factor for the X axis.", - "description": "
Sets the binning factor for the X axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "BinX" - ], - "type": "object", - "properties": { - "BinX": { - "type": "integer", - "description": "The X binning value", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "BinX": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/biny": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the binning factor for the Y axis.", - "description": "
Returns the binning factor for the Y axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the binning factor for the Y axis.", - "description": "
Sets the binning factor for the Y axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "BinY" - ], - "type": "object", - "properties": { - "BinY": { - "type": "integer", - "description": "The Y binning value", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "BinY": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/camerastate": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the camera operational state.", - "description": "
Returns the current camera operational state as an integer. 0 = CameraIdle , 1 = CameraWaiting , 2 = CameraExposing , 3 = CameraReading , 4 = CameraDownload , 5 = CameraError", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/cameraxsize": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the width of the CCD camera chip.", - "description": "
Returns the width of the CCD camera chip in unbinned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/cameraysize": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the height of the CCD camera chip.", - "description": "
Returns the height of the CCD camera chip in unbinned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/canabortexposure": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates whether the camera can abort exposures.", - "description": "
Returns true if the camera can abort exposures; false if not.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/canasymmetricbin": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates whether the camera supports asymmetric binning", - "description": "
Returns a flag showing whether this camera supports asymmetric binning", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/canfastreadout": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates whether the camera has a fast readout mode.", - "description": "
Indicates whether the camera has a fast readout mode.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/cangetcoolerpower": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates whether the camera's cooler power setting can be read.", - "description": "
If true, the camera's cooler power setting can be read.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/canpulseguide": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns a flag indicating whether this camera supports pulse guiding", - "description": "
Returns a flag indicating whether this camera supports pulse guiding.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/cansetccdtemperature": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns a flag indicating whether this camera supports setting the CCD temperature", - "description": "
Returns a flag indicatig whether this camera supports setting the CCD temperature", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/canstopexposure": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns a flag indicating whether this camera can stop an exposure that is in progress", - "description": "
Returns a flag indicating whether this camera can stop an exposure that is in progress", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/ccdtemperature": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current CCD temperature", - "description": "
Returns the current CCD temperature in degrees Celsius.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/cooleron": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current cooler on/off state.", - "description": "
Returns the current cooler on/off state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Turns the camera cooler on and off", - "description": "
Turns on and off the camera cooler. True = cooler on, False = cooler off", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "CoolerOn" - ], - "type": "object", - "properties": { - "CoolerOn": { - "type": "boolean", - "description": "Cooler state" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "CoolerOn": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/coolerpower": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the present cooler power level", - "description": "
Returns the present cooler power level, in percent.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/electronsperadu": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the gain of the camera", - "description": "
Returns the gain of the camera in photoelectrons per A/D unit.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/exposuremax": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the maximum exposure time supported by StartExposure.", - "description": "
Returns the maximum exposure time supported by StartExposure.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/exposuremin": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the Minimum exposure time", - "description": "
Returns the Minimum exposure time in seconds that the camera supports through StartExposure.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/exposureresolution": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the smallest increment in exposure time supported by StartExposure.", - "description": "
Returns the smallest increment in exposure time supported by StartExposure.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/fastreadout": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns whether Fast Readout Mode is enabled.", - "description": "
Returns whether Fast Readout Mode is enabled", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets whether Fast Readout Mode is enabled.", - "description": "
Sets whether Fast Readout Mode is enabled.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "FastReadout" - ], - "type": "object", - "properties": { - "FastReadout": { - "type": "boolean", - "description": "True to enable fast readout mode" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "FastReadout": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/fullwellcapacity": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Reports the full well capacity of the camera", - "description": "
Reports the full well capacity of the camera in electrons, at the current camera settings (binning, SetupDialog settings, etc.).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/gain": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the camera's gain", - "description": "
The camera's gain (GAIN VALUE MODE) OR the index of the selected camera gain description in the Gains array (GAINS INDEX MODE).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the camera's gain.", - "description": "
The camera's gain (GAIN VALUE MODE) OR the index of the selected camera gain description in the Gains array (GAINS INDEX MODE).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Gain" - ], - "type": "object", - "properties": { - "Gain": { - "type": "integer", - "description": "Index of the current camera gain in the Gains string array.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Gain": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/gainmax": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Maximum Gain value of that this camera supports", - "description": "
Returns the maximum value of Gain.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/gainmin": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Minimum Gain value of that this camera supports", - "description": "
Returns the Minimum value of Gain", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/gains": { - "get": { - "tags": [ - "Camera" - ], - "summary": "List of Gain names supported by the camera", - "description": "
Returns the Gains supported by the camera.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/hasshutter": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates whether the camera has a mechanical shutter", - "description": "
Returns a flag indicating whether this camera has a mechanical shutter.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/heatsinktemperature": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current heat sink temperature.", - "description": "
Returns the current heat sink temperature (called \"ambient temperature\" by some manufacturers) in degrees Celsius.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/imagearray": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns an array (2d or 3d of integers) containing the exposure pixel values", - "description": "
\r\n Returns an array containing the pixel values from the last exposure.\r\n This call can return either a 2 dimension (monochrome images) or 3 dimension (colour or multi-plane images) array of size NumX * NumY or NumX * NumY * NumPlanes.\r\n Where applicable, the size of NumPlanes has to be determined by inspection of the returned Array.\r\n \r\n
\r\n Since 32bit integers are always returned by this call, the returned JSON Type value (0 = Unknown, 1 = short(16bit), 2 = int(32bit), 3 = Double) is always 2. The number of planes is given in the returned Rank value.\r\n \r\n
\r\n When de-serialising to an object it helps enormously to know the array Rank beforehand so that the correct data class can be used. This can be achieved through a regular expression or by direct parsing of the returned JSON string to extract the Type and Rank values before de-serialising.\r\n \r\n
\r\n This regular expression accomplishes the extraction into two named groups Type and Rank, which can then be used to select the correct de-serialisation data class:\r\n \r\n
\r\n ^*\"Type\":(?\\d*),\"Rank\":(?\\d*)\r\n \r\n
\r\n When the SensorType is Monochrome, RGGB, CMYG, CMYG2 or LRGB, the serialised JSON array should have 2 dimensions. For example, the returned array should appear as below if NumX = 7, NumY = 5 and Pxy represents the pixel value at the zero based position x across and y down the image with the origin in the top left corner of the image. Please note that this is \"column-major\" order.\r\n \r\n
\r\n [\r\n [P00, P01, P02, P03, P04],\r\n [P10, P11, P12, P13, P14],\r\n [P20, P21, P22, P23, P24],\r\n [P30, P31, P32, P33, P34],\r\n [P40, P41, P42, P43, P44],\r\n [P50, P51, P52, P53, P54],\r\n [P60, P61, P62, P63, P64]\r\n ]\r\n \r\n
\r\n When the SensorType is Color, the serialised JSON array should have 3 dimensions.For example, the returned array should appear as below if NumX = 7, NumY = 5 and Rxy, Gxy and Bxy represent the red, green and blue pixel values at the zero based position x across and y down the image with the origin in the top left corner of the image.Please note that this is \"column-major\" order.\r\n \r\n
\r\n [\r\n [[R00, G00, B00],[R01, G01, B01],[R02, G02, B02],[R03, G03, B03],[R04, G04, B04]],\r\n [[R10, G10, B10],[R11, G11, B11],[R12, G12, B12],[R13, G13, B13],[R14, G14, B14]],\r\n [[R20, G20, B20],[R21, G21, B21],[R22, G22, B22],[R23, G23, B23],[R24, G24, B24]],\r\n [[R30, G30, B30],[R31, G31, B31],[R32, G32, B32],[R33, G33, B33],[R34, G34, B34]],\r\n [[R40, G40, B40],[R41, G41, B41],[R42, G42, B42],[R43, G43, B43],[R44, G44, B44]],\r\n [[R50, G50, B50],[R51, G51, B51],[R52, G52, B52],[R53, G53, B53],[R54, G54, B54]],\r\n [[R60, G60, B60],[R61, G61, B61],[R62, G62, B62],[R63, G63, B63],[R64, G64, B64]],\r\n ]\r\n ", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntArray2DResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/imagearrayvariant": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns an array containing the exposure pixel values", - "description": "
\r\n Returns an array containing the pixel values from the last exposure.\r\n This call can return either a 2 dimension (monochrome images) or 3 dimension (colour or multi-plane images) array of size NumX * NumY or NumX * NumY * NumPlanes.\r\n Where applicable, the size of NumPlanes has to be determined by inspection of the returned Array.\r\n \r\n
\r\n This call can return values as short(16bit) integers, int(32bit) integers or double floating point values. The nature of the returned values is given in the Type parameter: 0 = Unknown, 1 = short(16bit), 2 = int(32bit), 3 = Double. The number of planes is given in the returned Rank value.\r\n \r\n
\r\n When de-serialising to an object it helps enormously to know the array Rank beforehand so that the correct data class can be used. This can be achieved through a regular expression or by direct parsing of the returned JSON string to extract the Type and Rank values before de-serialising.\r\n \r\n
\r\n This regular expression accomplishes the extraction into two named groups Type and Rank, which can then be used to select the correct de-serialisation data class:\r\n \r\n
\r\n ^*\"Type\":(?\\d*),\"Rank\":(?\\d*)\r\n \r\n
\r\n When the SensorType is Monochrome, RGGB, CMYG, CMYG2 or LRGB, the serialised JSON array should have 2 dimensions. For example, the returned array should appear as below if NumX = 7, NumY = 5 and Pxy represents the pixel value at the zero based position x across and y down the image with the origin in the top left corner of the image. Please note that this is \"column-major\" order.\r\n \r\n
\r\n [\r\n [P00, P01, P02, P03, P04],\r\n [P10, P11, P12, P13, P14],\r\n [P20, P21, P22, P23, P24],\r\n [P30, P31, P32, P33, P34],\r\n [P40, P41, P42, P43, P44],\r\n [P50, P51, P52, P53, P54],\r\n [P60, P61, P62, P63, P64]\r\n ]\r\n \r\n
\r\n When the SensorType is Color, the serialised JSON array should have 3 dimensions.For example, the returned array should appear as below if NumX = 7, NumY = 5 and Rxy, Gxy and Bxy represent the red, green and blue pixel values at the zero based position x across and y down the image with the origin in the top left corner of the image.Please note that this is \"column-major\" order.\r\n \r\n
\r\n [\r\n [[R00, G00, B00],[R01, G01, B01],[R02, G02, B02],[R03, G03, B03],[R04, G04, B04]],\r\n [[R10, G10, B10],[R11, G11, B11],[R12, G12, B12],[R13, G13, B13],[R14, G14, B14]],\r\n [[R20, G20, B20],[R21, G21, B21],[R22, G22, B22],[R23, G23, B23],[R24, G24, B24]],\r\n [[R30, G30, B30],[R31, G31, B31],[R32, G32, B32],[R33, G33, B33],[R34, G34, B34]],\r\n [[R40, G40, B40],[R41, G41, B41],[R42, G42, B42],[R43, G43, B43],[R44, G44, B44]],\r\n [[R50, G50, B50],[R51, G51, B51],[R52, G52, B52],[R53, G53, B53],[R54, G54, B54]],\r\n [[R60, G60, B60],[R61, G61, B61],[R62, G62, B62],[R63, G63, B63],[R64, G64, B64]],\r\n ]\r\n ", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntArray2DResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/imageready": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates that an image is ready to be downloaded", - "description": "
Returns a flag indicating whether the image is ready to be downloaded from the camera.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/ispulseguiding": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates that the camera is pulse guiding.", - "description": "
Returns a flag indicating whether the camera is currently in a PulseGuide operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/lastexposureduration": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Duration of the last exposure", - "description": "
Reports the actual exposure duration in seconds (i.e. shutter open time).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/lastexposurestarttime": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Start time of the last exposure in FITS standard format.", - "description": "
Reports the actual exposure start in the FITS-standard CCYY-MM-DDThh:mm:ss[.sss...] format.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/maxadu": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Camera's maximum ADU value", - "description": "
Reports the maximum ADU value the camera can produce.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/maxbinx": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Maximum binning for the camera X axis", - "description": "
Returns the maximum allowed binning for the X camera axis", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/maxbiny": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Maximum binning for the camera Y axis", - "description": "
Returns the maximum allowed binning for the Y camera axis", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/numx": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current subframe width", - "description": "
Returns the current subframe width, if binning is active, value is in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the current subframe width", - "description": "
Sets the current subframe width.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "NumX" - ], - "type": "object", - "properties": { - "NumX": { - "type": "integer", - "description": "Sets the subframe width, if binning is active, value is in binned pixels.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "NumX": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/numy": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current subframe height", - "description": "
Returns the current subframe height, if binning is active, value is in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the current subframe height", - "description": "
Sets the current subframe height.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "NumY" - ], - "type": "object", - "properties": { - "NumY": { - "type": "integer", - "description": "Sets the subframe height, if binning is active, value is in binned pixels.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "NumY": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/offset": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the camera's offset", - "description": "
Returns the camera's offset (OFFSET VALUE MODE) OR the index of the selected camera offset description in the offsets array (OFFSETS INDEX MODE).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the camera's offset.", - "description": "
Sets the camera's offset (OFFSET VALUE MODE) OR the index of the selected camera offset description in the offsets array (OFFSETS INDEX MODE).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Offset" - ], - "type": "object", - "properties": { - "Offset": { - "type": "integer", - "description": "Index of the current camera offset in the offsets string array.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Offset": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/offsetmax": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Maximum offset value of that this camera supports", - "description": "
Returns the maximum value of offset.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/offsetmin": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Minimum offset value of that this camera supports", - "description": "
Returns the Minimum value of offset.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/offsets": { - "get": { - "tags": [ - "Camera" - ], - "summary": "List of offset names supported by the camera", - "description": "
Returns the offsets supported by the camera.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/percentcompleted": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates percentage completeness of the current operation", - "description": "
Returns the percentage of the current operation that is complete. If valid, returns an integer between 0 and 100, where 0 indicates 0% progress (function just started) and 100 indicates 100% progress (i.e. completion).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/pixelsizex": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Width of CCD chip pixels (microns)", - "description": "
Returns the width of the CCD chip pixels in microns.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/pixelsizey": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Height of CCD chip pixels (microns)", - "description": "
Returns the Height of the CCD chip pixels in microns.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/readoutmode": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Indicates the camera's readout mode as an index into the array ReadoutModes", - "description": "
ReadoutMode is an index into the array ReadoutModes and returns the desired readout mode for the camera. Defaults to 0 if not set.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Set the camera's readout mode", - "description": "
Sets the ReadoutMode as an index into the array ReadoutModes.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "ReadoutMode" - ], - "type": "object", - "properties": { - "ReadoutMode": { - "type": "integer", - "description": "Index into the ReadoutModes array of string readout mode names indicating the camera's current readout mode.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ReadoutMode": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/readoutmodes": { - "get": { - "tags": [ - "Camera" - ], - "summary": "List of available readout modes", - "description": "
This property provides an array of strings, each of which describes an available readout mode of the camera. At least one string must be present in the list.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/sensorname": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Sensor name", - "description": "
The name of the sensor used within the camera.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/sensortype": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Type of information returned by the the camera sensor (monochrome or colour)", - "description": "
Returns a value indicating whether the sensor is monochrome, or what Bayer matrix it encodes. Where:\r\n
0 = Monochrome,\r\n
1 = Colour not requiring Bayer decoding\r\n
2 = RGGB Bayer encoding\r\n
3 = CMYG Bayer encoding\r\n
4 = CMYG2 Bayer encoding\r\n
5 = LRGB TRUESENSE Bayer encoding.\r\n
Please see the ASCOM Help fie for more information on the SensorType.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/setccdtemperature": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the current camera cooler setpoint in degrees Celsius.", - "description": "
Returns the current camera cooler setpoint in degrees Celsius.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Set the camera's cooler setpoint (degrees Celsius).", - "description": "
Set's the camera's cooler setpoint in degrees Celsius.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SetCCDTemperature" - ], - "type": "object", - "properties": { - "SetCCDTemperature": { - "type": "number", - "description": "Temperature set point(degrees Celsius).", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SetCCDTemperature": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/startx": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Return the current subframe X axis start position", - "description": "
Sets the subframe start position for the X axis (0 based) and returns the current value. If binning is active, value is in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the current subframe X axis start position", - "description": "
Sets the current subframe X axis start position in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "StartX" - ], - "type": "object", - "properties": { - "StartX": { - "type": "integer", - "description": "The subframe X axis start position in binned pixels.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "StartX": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/starty": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Return the current subframe Y axis start position", - "description": "
Sets the subframe start position for the Y axis (0 based) and returns the current value. If binning is active, value is in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the current subframe Y axis start position", - "description": "
Sets the current subframe Y axis start position in binned pixels.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "StartY" - ], - "type": "object", - "properties": { - "StartY": { - "type": "integer", - "description": "The subframe Y axis start position in binned pixels.", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "StartY": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/subexposureduration": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Camera's sub-exposure interval", - "description": "
The Camera's sub exposure duration in seconds. Only available in Camera Interface Version 3 and later.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the current Sub Exposure Duration", - "description": "
Sets image sub exposure duration in seconds. Only available in Camera Interface Version 3 and later.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SubExposureDuration" - ], - "type": "object", - "properties": { - "SubExposureDuration": { - "type": "number", - "description": "The request sub exposure duration in seconds", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SubExposureDuration": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/abortexposure": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Aborts the current exposure", - "description": "
Aborts the current exposure, if any, and returns the camera to Idle state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/pulseguide": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Aborts the current exposure", - "description": "
Aborts the current exposure, if any, and returns the camera to Idle state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Direction", - "Duration" - ], - "type": "object", - "properties": { - "Direction": { - "$ref": "#/components/schemas/GuideDirection" - }, - "Duration": { - "type": "integer", - "description": "Duration of movement in milli-seconds", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Direction": { - "style": "form" - }, - "Duration": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/startexposure": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Starts an exposure", - "description": "
Starts an exposure. Use ImageReady to check when the exposure is complete.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Duration", - "Light" - ], - "type": "object", - "properties": { - "Duration": { - "type": "number", - "description": "Duration of exposure in seconds", - "format": "double" - }, - "Light": { - "type": "boolean", - "description": "True if light frame, false if dark frame." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Duration": { - "style": "form" - }, - "Light": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/stopexposure": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Stops the current exposure", - "description": "
Stops the current exposure, if any. If an exposure is in progress, the readout process is initiated. Ignored if readout is already in process.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/connect": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/action": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Camera" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Camera" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/description": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Camera" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/name": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/camera/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Camera" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/brightness": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the current calibrator brightness", - "description": "
Returns the current calibrator brightness in the range 0 (completely off) to MaxBrightness (fully on)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/calibratorchanging": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "True while the calibrator brightness is not stable.", - "description": "
True if the calibrator is stabilising after being set to a new brightness, otherwise False.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/calibratorstate": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the state of the calibration device", - "description": "
Returns the state of the calibration device, if present, otherwise returns \"NotPresent\". The calibrator state mode is specified as an integer value from the CalibratorStatus Enum.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/covermoving": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "True while the cover is moving.", - "description": "
True while the cover is moving to its new position after an OpenCover or CloseCover command.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/coverstate": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the state of the device cover", - "description": "
Returns the state of the device cover, if present, otherwise returns \"NotPresent\". The cover state mode is specified as an integer value from the CoverStatus Enum.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/maxbrightness": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the calibrator's maximum Brightness value.", - "description": "
The Brightness value that makes the calibrator deliver its maximum illumination.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/calibratoroff": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Turns the calibrator off", - "description": "
Turns the calibrator off if the device has calibration capability.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/calibratoron": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Turns the calibrator on at the specified brightness", - "description": "
Turns the calibrator on at the specified brightness if the device has calibration capability.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Brightness" - ], - "type": "object", - "properties": { - "Brightness": { - "type": "integer", - "description": "The required brightness in the range 0 to MaxBrightness", - "format": "int32", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Brightness": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/closecover": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Initiates cover closing", - "description": "
Initiates cover closing if a cover is present.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/haltcover": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Stops any cover movement that may be in progress", - "description": "
Stops any cover movement that may be in progress if a cover is present and cover movement can be interrupted.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/opencover": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Initiates cover opening", - "description": "
Initiates cover opening if a cover is present.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/connect": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/action": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/connected": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/description": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/name": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/covercalibrator/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "CoverCalibrator" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/altitude": { - "get": { - "tags": [ - "Dome" - ], - "summary": "The dome altitude", - "description": "
The dome altitude (degrees, horizon zero and increasing positive to 90 zenith).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/athome": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome is in the home position.", - "description": "
Indicates whether the dome is in the home position.\r\n This is normally used following a FindHome() operation.\r\n The value is reset with any azimuth slew operation that moves the dome away from the home position.\r\n AtHome may also become true during normal slew operations,\r\n if the dome passes through the home position and the dome controller hardware is capable of detecting that;\r\n or at the end of a slew operation if the dome comes to rest at the home position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/atpark": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome is at the park position", - "description": "
True if the dome is in the programmed park position. Set only following a Park() operation and reset with any slew operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/azimuth": { - "get": { - "tags": [ - "Dome" - ], - "summary": "The dome azimuth", - "description": "
Returns the dome azimuth (degrees, North zero and increasing clockwise, i.e., 90 East, 180 South, 270 West)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/canfindhome": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome can find the home position.", - "description": "
True if the dome can move to the home position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/canpark": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome can be parked.", - "description": "
True if the dome is capable of programmed parking (Park() method)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/cansetaltitude": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome altitude can be set", - "description": "
True if driver is capable of setting the dome altitude.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/cansetazimuth": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome azimuth can be set", - "description": "
True if driver is capable of setting the dome azimuth.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/cansetpark": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome park position can be set", - "description": "
True if driver is capable of setting the dome park position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/cansetshutter": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome shutter can be opened", - "description": "
True if driver is capable of automatically operating shutter", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/canslave": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome supports slaving to a telescope", - "description": "
True if driver is capable of slaving to a telescope.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/cansyncazimuth": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome azimuth position can be synced", - "description": "
True if driver is capable of synchronizing the dome azimuth position using the SyncToAzimuth(Double) method.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/shutterstatus": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Status of the dome shutter or roll-off roof", - "description": "
Returns the status of the dome shutter or roll-off roof. 0 = Open, 1 = Closed, 2 = Opening, 3 = Closing, 4 = Shutter status error", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/slaved": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the dome is slaved to the telescope", - "description": "
True if the dome is slaved to the telescope in its hardware, else False.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Dome" - ], - "summary": "Sets whether the dome is slaved to the telescope", - "description": "
Sets whether the dome is slaved to the telescope", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Slaved" - ], - "type": "object", - "properties": { - "Slaved": { - "type": "boolean", - "description": "True if telescope is slaved to dome, otherwise false" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Slaved": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/slewing": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Indicates whether the any part of the dome is moving", - "description": "
True if any part of the dome is currently moving, False if all dome components are steady.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/abortslew": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Immediately cancel current dome operation.", - "description": "
Calling this method will immediately disable hardware slewing (Slaved will become False).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/closeshutter": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Close the shutter or otherwise shield telescope from the sky.", - "description": "
Close the shutter or otherwise shield telescope from the sky.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/findhome": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Start operation to search for the dome home position.", - "description": "
After Home position is established initializes Azimuth to the default value and sets the AtHome flag.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/openshutter": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Open shutter or otherwise expose telescope to the sky.", - "description": "
Open shutter or otherwise expose telescope to the sky.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/park": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Rotate dome in azimuth to park position.", - "description": "
After assuming programmed park position, sets AtPark flag.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/setpark": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Set the current azimuth, altitude position of dome to be the park position.", - "description": "
Set the current azimuth, altitude position of dome to be the park position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/slewtoaltitude": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Slew the dome to the given altitude position.", - "description": "
Slew the dome to the given altitude position", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Altitude" - ], - "type": "object", - "properties": { - "Altitude": { - "type": "number", - "description": "Target dome altitude (degrees, horizon zero and increasing positive to 90 zenith0", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Altitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/slewtoazimuth": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Slew the dome to the given azimuth position.", - "description": "
Slew the dome to the given azimuth position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Azimuth" - ], - "type": "object", - "properties": { - "Azimuth": { - "type": "number", - "description": "Target dome azimuth (degrees, North zero and increasing clockwise. i.e., 90 East, 180 South, 270 West)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Azimuth": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/synctoazimuth": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Synchronize the dome to the given azimuth position.", - "description": "
Synchronize the dome to the given azimuth position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Azimuth" - ], - "type": "object", - "properties": { - "Azimuth": { - "type": "number", - "description": "Target dome azimuth (degrees, North zero and increasing clockwise. i.e., 90 East, 180 South, 270 West)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Azimuth": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/connect": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/action": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Dome" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Dome" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/description": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Dome" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/name": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/dome/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Dome" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/focusoffsets": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Filter focus offsets", - "description": "
An integer array of filter focus offsets.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/names": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Filter wheel filter names", - "description": "
The names of the filters", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/position": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Returns the current filter wheel position", - "description": "
Returns the current filter wheel position", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Sets the filter wheel position", - "description": "
Sets the filter wheel position", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "integer", - "description": "Sets the filter wheel position", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/connect": { - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/action": { - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/connected": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "FilterWheel" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/description": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/name": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/filterwheel/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "FilterWheel" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/absolute": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Indicates whether the focuser is capable of absolute position.", - "description": "
True if the focuser is capable of absolute position; that is, being commanded to a specific step location.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/ismoving": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Indicates whether the focuser is currently moving.", - "description": "
True if the focuser is currently moving to a new position. False if the focuser is stationary.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/maxincrement": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the focuser's maximum increment size.", - "description": "
Maximum increment size allowed by the focuser; i.e. the maximum number of steps allowed in one move operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/maxstep": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the focuser's maximum step size.", - "description": "
Maximum step position permitted.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/position": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the focuser's current position.", - "description": "
Current focuser position, in steps.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/stepsize": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the focuser's step size.", - "description": "
Step size (microns) for the focuser.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/tempcomp": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Retrieves the state of temperature compensation mode", - "description": "
Gets the state of temperature compensation mode (if available), else always False.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Focuser" - ], - "summary": "Sets the device's temperature compensation mode.", - "description": "
Sets the state of temperature compensation mode.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "TempComp" - ], - "type": "object", - "properties": { - "TempComp": { - "type": "boolean", - "description": "Set true to enable the focuser's temperature compensation mode, otherwise false for normal operation." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "TempComp": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/tempcompavailable": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Indicates whether the focuser has temperature compensation.", - "description": "
True if focuser has temperature compensation available.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/temperature": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the focuser's current temperature.", - "description": "
Current ambient temperature as measured by the focuser.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/halt": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Immediately stops focuser motion.", - "description": "
Immediately stop any focuser motion due to a previous Move(Int32) method call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/move": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Moves the focuser to a new position.", - "description": "
Moves the focuser by the specified amount or to the specified position depending on the value of the Absolute property.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "integer", - "description": "Step distance or absolute position, depending on the value of the Absolute property", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/connect": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/action": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Focuser" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Focuser" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/description": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/name": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/focuser/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Focuser" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/management/apiversions": { - "get": { - "tags": [ - "Management" - ], - "summary": "Supported Alpaca API versions", - "description": "
Returns an integer array of supported Alpaca API version numbers.", - "parameters": [ - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/management/v1/description": { - "get": { - "tags": [ - "Management" - ], - "summary": "Summary information about this device as a whole", - "description": "
Summary information about each available ASCOM device", - "parameters": [ - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AlpacaDescriptionResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/management/v1/configureddevices": { - "get": { - "tags": [ - "Management" - ], - "summary": "Summary information about each available ASCOM device", - "description": "
Returns an array of device description objects, providing unique information for each served device, enabling them to be accessed through the Alpaca Device API.", - "parameters": [ - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AlpacaConfiguredDevicesResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/averageperiod": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the time period over which observations will be averaged", - "description": "
Gets the time period over which observations will be averaged", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Sets the time period over which observations will be averaged", - "description": "
Sets the time period over which observations will be averaged", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "AveragePeriod" - ], - "type": "object", - "properties": { - "AveragePeriod": { - "type": "number", - "description": "Time period(hours) over which to average sensor readings", - "format": "double", - "default": 1 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "AveragePeriod": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/cloudcover": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the amount of sky obscured by cloud", - "description": "
Gets the percentage of the sky obscured by cloud", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/dewpoint": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the atmospheric dew point at the observatory", - "description": "
Gets the atmospheric dew point at the observatory reported in °C.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/humidity": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the atmospheric humidity at the observatory", - "description": "
Gets the atmospheric humidity (%) at the observatory", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/pressure": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the atmospheric pressure at the observatory.", - "description": "
Gets the atmospheric pressure in hectoPascals at the observatory's altitude - NOT reduced to sea level.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/rainrate": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the rain rate at the observatory.", - "description": "
Gets the rain rate (mm/hour) at the observatory.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/skybrightness": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the sky brightness at the observatory", - "description": "
Gets the sky brightness at the observatory (Lux)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/skyquality": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the sky quality at the observatory", - "description": "
Gets the sky quality at the observatory (magnitudes per square arc second)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/skytemperature": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the sky temperature at the observatory", - "description": "
Gets the sky temperature(°C) at the observatory.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/starfwhm": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the seeing at the observatory", - "description": "
Gets the seeing at the observatory measured as star full width half maximum (FWHM) in arc secs.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/temperature": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the temperature at the observatory", - "description": "
Gets the temperature(°C) at the observatory.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/winddirection": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the wind direction at the observatory", - "description": "
Gets the wind direction. The returned value must be between 0.0 and 360.0, interpreted according to the metereological standard, where a special value of 0.0 is returned when the wind speed is 0.0. Wind direction is measured clockwise from north, through east, where East=90.0, South=180.0, West=270.0 and North=360.0.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/windgust": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the peak 3 second wind gust at the observatory over the last 2 minutes", - "description": "
Gets the peak 3 second wind gust(m/s) at the observatory over the last 2 minutes.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/windspeed": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the wind speed at the observatory.", - "description": "
Gets the wind speed(m/s) at the observatory.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/refresh": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Refreshes sensor values from hardware.", - "description": "
Forces the driver to immediately query its attached hardware to refresh sensor values.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/sensordescription": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Return a sensor description", - "description": "
Gets a description of the sensor with the name specified in the SensorName parameter", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "SensorName", - "in": "query", - "description": "Name of the sensor whose description is required", - "required": true, - "schema": { - "type": "string", - "description": "Name of the sensor whose description is required" - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/timesincelastupdate": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Return the time since the sensor value was last updated", - "description": "
Gets the time since the sensor specified in the SensorName parameter was last updated", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "SensorName", - "in": "query", - "description": "Name of the sensor whose description is required", - "schema": { - "type": "string", - "description": "Name of the sensor whose description is required", - "default": "" - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/connect": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/action": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/connected": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "ObservingConditions" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/description": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/name": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/observingconditions/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "ObservingConditions" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/canreverse": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Indicates whether the Rotator supports the Reverse method.", - "description": "
True if the Rotator supports the Reverse method.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/ismoving": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Indicates whether the rotator is currently moving.", - "description": "
True if the rotator is currently moving to a new position. False if the focuser is stationary.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/mechanicalposition": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the rotator’s Reverse state.", - "description": "
Returns the rotator’s Reverse state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/position": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the rotator's current position.", - "description": "
Current instantaneous Rotator position, in degrees.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/reverse": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the rotator’s Reverse state.", - "description": "
Returns the rotator’s Reverse state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Rotator" - ], - "summary": "Sets the rotator’s Reverse state.", - "description": "
Sets the rotator’s Reverse state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Reverse" - ], - "type": "object", - "properties": { - "Reverse": { - "type": "boolean", - "description": "True if the rotation and angular direction must be reversed to match the optical characteristcs" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Reverse": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/stepsize": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the minimum StepSize", - "description": "
The minimum StepSize, in degrees.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/targetposition": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the destination position angle.", - "description": "
The destination position angle for Move() and MoveAbsolute().", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/halt": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Immediately stops rotator motion.", - "description": "
Immediately stop any Rotator motion due to a previous Move or MoveAbsolute method call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/move": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Moves the rotator to a new relative position.", - "description": "
Causes the rotator to move Position degrees relative to the current Position value.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "number", - "description": "Relative position to move in degrees from current Position.", - "format": "double", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/moveabsolute": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Moves the rotator to a new absolute position.", - "description": "
Causes the rotator to move the absolute position of Position degrees.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "number", - "description": "Absolute position in degrees.", - "format": "double", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/movemechanical": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Moves the rotator to a new raw mechanical position.", - "description": "
Causes the rotator to move the mechanical position of Position degrees.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "number", - "description": "Absolute position in degrees.", - "format": "double", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/sync": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Syncs the rotator to the specified position angle without moving it.", - "description": "
Causes the rotator to sync to the position of Position degrees.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Position" - ], - "type": "object", - "properties": { - "Position": { - "type": "number", - "description": "Absolute position in degrees.", - "format": "double", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Position": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/connect": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/action": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Rotator" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Rotator" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/description": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/name": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/rotator/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Rotator" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/issafe": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Indicates whether the monitored state is safe for use.", - "description": "
Indicates whether the monitored state is safe for use. True if the state is safe, False if it is unsafe.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/connect": { - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/action": { - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/connected": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/description": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/name": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/safetymonitor/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "SafetyMonitor" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/camera/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/covercalibrator/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/dome/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/filterwheel/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/focuser/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/observingconditions/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/rotator/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/safetymonitor/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/switch/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/telescope/{DeviceNumber}/reset": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Resets a device settings to the simulator default", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/camera/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/covercalibrator/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/dome/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/filterwheel/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/focuser/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/observingconditions/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/rotator/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/safetymonitor/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/switch/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/telescope/{DeviceNumber}/restart": { - "put": { - "tags": [ - "Simulator" - ], - "summary": "OmniSim only API - Restarts a device simulator to the simulator stored settings and a clean state. This can be used to restart a device so it behaves like the OmniSim server was just freshly started, without restarting the whole OmniSim.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/camera/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/covercalibrator/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/dome/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/filterwheel/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/focuser/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/observingconditions/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/rotator/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/safetymonitor/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/switch/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/simulator/v1/telescope/{DeviceNumber}/xmlprofile": { - "get": { - "tags": [ - "Simulator" - ], - "summary": "Gets a copy of the profile. This is returned as a string value in the standard Response Value field.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/maxswitch": { - "get": { - "tags": [ - "Switch" - ], - "summary": "The number of switch devices managed by this driver", - "description": "
Returns the number of switch devices managed by this driver. Devices are numbered from 0 to MaxSwitch - 1", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/canwrite": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Indicates whether the specified switch device can be written to", - "description": "
Reports if the specified switch device can be written to, default true. This is false if the device cannot be written to, for example a limit switch or a sensor. Devices are numbered from 0 to MaxSwitch - 1", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/getswitch": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Return the state of switch device id as a boolean", - "description": "
Return the state of switch device id as a boolean. Devices are numbered from 0 to MaxSwitch - 1", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/getswitchdescription": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Gets the description of the specified switch device", - "description": "
Gets the description of the specified switch device. This is to allow a fuller description of the device to be returned, for example for a tool tip. Devices are numbered from 0 to MaxSwitch - 1", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/getswitchname": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Gets the name of the specified switch device", - "description": "
Gets the name of the specified switch device. Devices are numbered from 0 to MaxSwitch - 1", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/getswitchvalue": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Gets the value of the specified switch device as a double", - "description": "
Gets the value of the specified switch device as a double. Devices are numbered from 0 to MaxSwitch - 1, The value of this switch is expected to be between MinSwitchValue and MaxSwitchValue.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/minswitchvalue": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Gets the minimum value of the specified switch device as a double", - "description": "
Gets the minimum value of the specified switch device as a double. Devices are numbered from 0 to MaxSwitch - 1.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/maxswitchvalue": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Gets the maximum value of the specified switch device as a double", - "description": "
Gets the maximum value of the specified switch device as a double. Devices are numbered from 0 to MaxSwitch - 1.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/switchstep": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Returns the step size that this device supports (the difference between successive values of the device).", - "description": "
Returns the step size that this device supports (the difference between successive values of the device). Devices are numbered from 0 to MaxSwitch - 1.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/setswitch": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Sets a switch controller device to the specified state, true or false", - "description": "
Sets a switch controller device to the specified state, true or false.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "ID", - "State" - ], - "type": "object", - "properties": { - "ID": { - "type": "integer", - "description": "The device number (0 to MaxSwitch - 1)", - "format": "int32", - "default": 0 - }, - "State": { - "type": "boolean", - "description": "The required control state(True or False)" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ID": { - "style": "form" - }, - "State": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/setswitchname": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Sets a switch device name to the specified value", - "description": "
Sets a switch device name to the specified value.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "ID", - "Name" - ], - "type": "object", - "properties": { - "ID": { - "type": "integer", - "description": "The device number (0 to MaxSwitch - 1)", - "format": "int32", - "default": 0 - }, - "Name": { - "type": "string", - "description": "The name of the device" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ID": { - "style": "form" - }, - "Name": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/setswitchvalue": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Sets a switch device value to the specified value", - "description": "
Sets a switch device value to the specified value.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "ID", - "Value" - ], - "type": "object", - "properties": { - "ID": { - "type": "integer", - "description": "The device number (0 to MaxSwitch - 1)", - "format": "int32", - "default": 0 - }, - "Value": { - "type": "number", - "description": "The value to be set, between MinSwitchValue and MaxSwitchValue", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ID": { - "style": "form" - }, - "Value": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/canasync": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Flag indicating whether this switch can operate asynchronously.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/statechangecomplete": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Completion variable for asynchronous changes.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ID", - "in": "query", - "description": "The device number (0 to MaxSwitch - 1)", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/cancelasync": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Cancels an in-progress asynchronous operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "ID" - ], - "type": "object", - "properties": { - "ID": { - "type": "integer", - "description": "The device number (0 to MaxSwitch - 1)", - "format": "int32", - "default": 0 - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ID": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/setasync": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Set a boolean switch's state asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "ID", - "State" - ], - "type": "object", - "properties": { - "ID": { - "type": "integer", - "description": "The device number (0 to MaxSwitch - 1)", - "format": "int32", - "default": 0 - }, - "State": { - "type": "boolean", - "description": "The required control state(True or False)" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ID": { - "style": "form" - }, - "State": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/setasyncvalue": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Set a switch's value asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "ID", - "Value" - ], - "type": "object", - "properties": { - "ID": { - "type": "integer", - "description": "The device number (0 to MaxSwitch - 1)", - "format": "int32", - "default": 0 - }, - "Value": { - "type": "number", - "description": "The value to be set, between MinSwitchValue and MaxSwitchValue", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ID": { - "style": "form" - }, - "Value": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/connect": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/action": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Switch" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Switch" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/description": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Switch" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/name": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/switch/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Switch" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/abortslew": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Immediately stops a slew in progress.", - "description": "
Immediately Stops a slew in progress.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/alignmentmode": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current mount alignment mode", - "description": "
Returns the alignment mode of the mount (Alt/Az, Polar, German Polar). The alignment mode is specified as an integer value from the AlignmentModes Enum.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/altitude": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the mount's altitude above the horizon.", - "description": "
The altitude above the local horizon of the mount's current position (degrees, positive up)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/aperturearea": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the telescope's aperture.", - "description": "
The area of the telescope's aperture, taking into account any obstructions (square meters)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/aperturediameter": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the telescope's effective aperture.", - "description": "
The telescope's effective aperture diameter (meters)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/athome": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the mount is at the home position.", - "description": "
True if the mount is stopped in the Home position. Set only following a FindHome() operation, and reset with any slew operation. This property must be False if the telescope does not support homing.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/atpark": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope is at the park position.", - "description": "
True if the telescope has been put into the parked state by the see Park() method. Set False by calling the Unpark() method.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/axisrates": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the rates at which the telescope may be moved about the specified axis.", - "description": "
The rates at which the telescope may be moved about the specified axis by the MoveAxis(TelescopeAxes, Double) method.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "Axis", - "in": "query", - "description": "The axis about which rate information is desired. 0 = axisPrimary, 1 = axisSecondary, 2 = axisTertiary.", - "required": true, - "schema": { - "$ref": "#/components/schemas/TelescopeAxis" - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AxisRatesResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/azimuth": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the mount's azimuth.", - "description": "
The azimuth at the local horizon of the mount's current position (degrees, North-referenced, positive East/clockwise).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canfindhome": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the mount can find the home position.", - "description": "
True if this telescope is capable of programmed finding its home position (FindHome() method).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canmoveaxis": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can move the requested axis.", - "description": "
True if this telescope can move the requested axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "Axis", - "in": "query", - "description": "The axis about which rate information is desired. 0 = axisPrimary, 1 = axisSecondary, 2 = axisTertiary.", - "required": true, - "schema": { - "$ref": "#/components/schemas/TelescopeAxis" - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canpark": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can be parked.", - "description": "
True if this telescope is capable of programmed parking (Park() method)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canpulseguide": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can be pulse guided.", - "description": "
True if this telescope is capable of software-pulsed guiding (via the PulseGuide(GuideDirections, Int32) method)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansetdeclinationrate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the DeclinationRate property can be changed.", - "description": "
True if the DeclinationRate property can be changed to provide offset tracking in the declination axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansetguiderates": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the Guide Rates can be changed.", - "description": "
True if the guide rate properties used for PulseGuide(GuideDirections, Int32) can be adjusted.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansetpark": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope park position can be set.", - "description": "
True if this telescope is capable of programmed setting of its park position (SetPark() method)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansetpierside": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope SideOfPier can be set.", - "description": "
True if the SideOfPier property can be set, meaning that the mount can be forced to flip.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansetrightascensionrate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the RightAscensionRate property can be changed.", - "description": "
True if the RightAscensionRate property can be changed to provide offset tracking in the right ascension axis.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansettracking": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the Tracking property can be changed.", - "description": "
True if the Tracking property can be changed, turning telescope sidereal tracking on and off.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canslew": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can slew synchronously.", - "description": "
True if this telescope is capable of programmed slewing (synchronous or asynchronous) to equatorial coordinates", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canslewaltaz": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can slew synchronously to AltAz coordinates.", - "description": "
True if this telescope is capable of programmed slewing (synchronous or asynchronous) to local horizontal coordinates", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canslewaltazasync": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can slew asynchronously to AltAz coordinates.", - "description": "
True if this telescope is capable of programmed asynchronous slewing to local horizontal coordinates", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canslewasync": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can slew asynchronously.", - "description": "
True if this telescope is capable of programmed asynchronous slewing to equatorial coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansync": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can sync to equatorial coordinates.", - "description": "
True if this telescope is capable of programmed syncing to equatorial coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/cansyncaltaz": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can sync to local horizontal coordinates.", - "description": "
True if this telescope is capable of programmed syncing to local horizontal coordinates", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/canunpark": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope can be unparked.", - "description": "
True if this telescope is capable of programmed unparking (Unpark() method)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/declination": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the mount's declination.", - "description": "
The declination (degrees) of the mount's current equatorial coordinates, in the coordinate system given by the EquatorialSystem property. Reading the property will raise an error if the value is unavailable.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/declinationrate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the telescope's declination tracking rate.", - "description": "
The declination tracking rate (arcseconds per SI second, default = 0.0). Please note that rightascensionrate units are arcseconds per sidereal second.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the telescope's declination tracking rate.", - "description": "
Sets the declination tracking rate (arcseconds per SI second). Please note that rightascensionrate units are arcseconds per sidereal second.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "DeclinationRate" - ], - "type": "object", - "properties": { - "DeclinationRate": { - "type": "number", - "description": "Declination tracking rate (arcseconds per SI second). Please note that rightascensionrate units are arcseconds per sidereal second.", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "DeclinationRate": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/destinationsideofpier": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Predicts the pointing state after a German equatorial mount slews to given coordinates.", - "description": "
Predicts the pointing state that a German equatorial mount will be in if it slews to the given coordinates. The return value will be one of - 0 = pierEast, 1 = pierWest, -1 = pierUnknown", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "RightAscension", - "in": "query", - "description": "Right Ascension coordinate (0.0 to 23.99999999 hours)", - "required": true, - "schema": { - "type": "number", - "description": "Right Ascension coordinate (0.0 to 23.99999999 hours)", - "format": "double" - } - }, - { - "name": "Declination", - "in": "query", - "description": "Declination coordinate (-90.0 to +90.0 degrees)", - "required": true, - "schema": { - "type": "number", - "description": "Declination coordinate (-90.0 to +90.0 degrees)", - "format": "double" - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/doesrefraction": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether atmospheric refraction is applied to coordinates.", - "description": "
True if the telescope or driver applies atmospheric refraction to coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Determines whether atmospheric refraction is applied to coordinates.", - "description": "
Determines whether atmospheric refraction is applied to coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "DoesRefraction" - ], - "type": "object", - "properties": { - "DoesRefraction": { - "type": "boolean", - "description": "Determines whether atmospheric refraction is applied to coordinates." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "DoesRefraction": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/equatorialsystem": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current equatorial coordinate system used by this telescope.", - "description": "
Returns the current equatorial coordinate system used by this telescope (e.g. Topocentric or J2000).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/findhome": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Moves the mount to the \"home\" position.", - "description": "
Locates the telescope's \"home\" position (synchronous)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/focallength": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the telescope's focal length in meters.", - "description": "
The telescope's focal length in meters", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/guideratedeclination": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Sets the current Declination rate offset for telescope guiding.", - "description": "
The current Declination movement rate offset for telescope guiding (degrees/sec)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current Declination rate offset for telescope guiding", - "description": "
Sets the current Declination movement rate offset for telescope guiding (degrees/sec).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "GuideRateDeclination" - ], - "type": "object", - "properties": { - "GuideRateDeclination": { - "type": "number", - "description": "Declination movement rate offset degrees/sec).", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "GuideRateDeclination": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/guideraterightascension": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current RightAscension rate offset for telescope guiding", - "description": "
The current RightAscension movement rate offset for telescope guiding (degrees/sec)", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the current RightAscension rate offset for telescope guiding.", - "description": "
Sets the current RightAscension movement rate offset for telescope guiding (degrees/sec).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "GuideRateRightAscension" - ], - "type": "object", - "properties": { - "GuideRateRightAscension": { - "type": "number", - "description": "RightAscension movement rate offset (degrees/sec).", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "GuideRateRightAscension": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/ispulseguiding": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope is currently executing a PulseGuide command", - "description": "
True if a PulseGuide(GuideDirections, Int32) command is in progress, False otherwise", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/moveaxis": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Moves a telescope axis at the given rate.", - "description": "
Move the telescope in one axis at the given rate.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Axis", - "Rate" - ], - "type": "object", - "properties": { - "Axis": { - "$ref": "#/components/schemas/TelescopeAxis" - }, - "Rate": { - "type": "number", - "description": "The rate of motion (deg/sec) about the specified axis", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Axis": { - "style": "form" - }, - "Rate": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/park": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Park the mount", - "description": "
Move the telescope to its park position, stop all motion (or restrict to a small safe range), and set AtPark to True.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/pulseguide": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Moves the scope in the given direction for the given time.", - "description": "
Moves the scope in the given direction for the given interval or time at the rate given by the corresponding guide rate property", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Direction", - "Duration" - ], - "type": "object", - "properties": { - "Direction": { - "$ref": "#/components/schemas/GuideDirection" - }, - "Duration": { - "type": "integer", - "description": "The duration of the guide-rate motion (milliseconds)", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Direction": { - "style": "form" - }, - "Duration": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/rightascension": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the mount's right ascension coordinate.", - "description": "
The right ascension (hours) of the mount's current equatorial coordinates, in the coordinate system given by the EquatorialSystem property", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/rightascensionrate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the telescope's right ascension tracking rate.", - "description": "
The right ascension tracking rate (arcseconds per sidereal second, default = 0.0). Please note that the declinationrate units are arcseconds per SI second.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the telescope's right ascension tracking rate.", - "description": "
Sets the right ascension tracking rate (arcseconds per sidereal second). Please note that the declinationrate units are arcseconds per SI second.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "RightAscensionRate" - ], - "type": "object", - "properties": { - "RightAscensionRate": { - "type": "number", - "description": "Right ascension tracking rate (arcseconds per sideral second). Please note that the declinationrate units are arcseconds per SI second.", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "RightAscensionRate": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/setpark": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the telescope's park position", - "description": "
Sets the telescope's park position to be its current position.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/sideofpier": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the mount's pointing state.", - "description": "
Indicates the pointing state of the mount. 0 = pierEast, 1 = pierWest, -1= pierUnknown", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the mount's pointing state.", - "description": "
Sets the pointing state of the mount. 0 = pierEast, 1 = pierWest", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SideOfPier" - ], - "type": "object", - "properties": { - "SideOfPier": { - "$ref": "#/components/schemas/PointingState" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SideOfPier": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/siderealtime": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the local apparent sidereal time.", - "description": "
The local apparent sidereal time from the telescope's internal clock (hours, sidereal).The local apparent sidereal time from the telescope's internal clock (hours, sidereal).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/siteelevation": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the observing site's elevation above mean sea level.", - "description": "
The elevation above mean sea level (meters) of the site at which the telescope is located.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the observing site's elevation above mean sea level.", - "description": "
Sets the elevation above mean sea level (metres) of the site at which the telescope is located.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SiteElevation" - ], - "type": "object", - "properties": { - "SiteElevation": { - "type": "number", - "description": "Elevation above mean sea level (metres).", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SiteElevation": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/sitelatitude": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the observing site's latitude.", - "description": "
The geodetic(map) latitude (degrees, positive North, WGS84) of the site at which the telescope is located.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the observing site's latitude.", - "description": "
Sets the observing site's latitude (degrees).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SiteLatitude" - ], - "type": "object", - "properties": { - "SiteLatitude": { - "type": "number", - "description": "Site latitude (degrees)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SiteLatitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/sitelongitude": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the observing site's longitude.", - "description": "
The longitude (degrees, positive East, WGS84) of the site at which the telescope is located.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the observing site's longitude.", - "description": "
Sets the observing site's longitude (degrees, positive East, WGS84).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SiteLongitude" - ], - "type": "object", - "properties": { - "SiteLongitude": { - "type": "number", - "description": "Site longitude (degrees, positive East, WGS84)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SiteLongitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewing": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope is currently slewing.", - "description": "
True if telescope is currently moving in response to one of the Slew methods or the MoveAxis(TelescopeAxes, Double) method, False at all other times.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewsettletime": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the post-slew settling time.", - "description": "
Returns the post-slew settling time (sec.).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the post-slew settling time.", - "description": "
Sets the post-slew settling time (integer sec.).", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "SlewSettleTime" - ], - "type": "object", - "properties": { - "SlewSettleTime": { - "type": "integer", - "description": "Settling time (integer sec.).", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "SlewSettleTime": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtoaltaz": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Synchronously slew to the given local horizontal coordinates.", - "description": "
Move the telescope to the given local horizontal coordinates, return when slew is complete", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Altitude", - "Azimuth" - ], - "type": "object", - "properties": { - "Azimuth": { - "type": "number", - "description": "Azimuth coordinate (degrees, North-referenced, positive East/clockwise)", - "format": "double" - }, - "Altitude": { - "type": "number", - "description": "Altitude coordinate (degrees, positive up)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Azimuth": { - "style": "form" - }, - "Altitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtoaltazasync": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Asynchronously slew to the given local horizontal coordinates.", - "description": "
Move the telescope to the given local horizontal coordinates, return immediately after the slew starts. The client can poll the Slewing method to determine when the mount reaches the intended coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Altitude", - "Azimuth" - ], - "type": "object", - "properties": { - "Azimuth": { - "type": "number", - "description": "Azimuth coordinate (degrees, North-referenced, positive East/clockwise)", - "format": "double" - }, - "Altitude": { - "type": "number", - "description": "Altitude coordinate (degrees, positive up)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Azimuth": { - "style": "form" - }, - "Altitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtocoordinates": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Synchronously slew to the given equatorial coordinates.", - "description": "
Move the telescope to the given equatorial coordinates, return when slew is complete", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Declination", - "RightAscension" - ], - "type": "object", - "properties": { - "RightAscension": { - "type": "number", - "description": "Right Ascension coordinate (hours)", - "format": "double" - }, - "Declination": { - "type": "number", - "description": "Declination coordinate (degrees)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "RightAscension": { - "style": "form" - }, - "Declination": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtocoordinatesasync": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Synchronously slew to the given equatorial coordinates.", - "description": "
Move the telescope to the given equatorial coordinates, return when slew is complete", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Declination", - "RightAscension" - ], - "type": "object", - "properties": { - "RightAscension": { - "type": "number", - "description": "Right Ascension coordinate (hours)", - "format": "double" - }, - "Declination": { - "type": "number", - "description": "Declination coordinate (degrees)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "RightAscension": { - "style": "form" - }, - "Declination": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtotarget": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Synchronously slew to the TargetRightAscension and TargetDeclination coordinates.", - "description": "
Move the telescope to the TargetRightAscension and TargetDeclination equatorial coordinates, return when slew is complete", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/slewtotargetasync": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Asynchronously slew to the TargetRightAscension and TargetDeclination coordinates.", - "description": "
Move the telescope to the TargetRightAscension and TargetDeclination equatorial coordinates, return immediatley after the slew starts. The client can poll the Slewing method to determine when the mount reaches the intended coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/synctoaltaz": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Syncs to the given local horizontal coordinates.", - "description": "
Matches the scope's local horizontal coordinates to the given local horizontal coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Altitude", - "Azimuth" - ], - "type": "object", - "properties": { - "Azimuth": { - "type": "number", - "description": "Azimuth coordinate (degrees, North-referenced, positive East/clockwise)", - "format": "double" - }, - "Altitude": { - "type": "number", - "description": "Altitude coordinate (degrees, positive up)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Azimuth": { - "style": "form" - }, - "Altitude": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/synctocoordinates": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Syncs to the given equatorial coordinates.", - "description": "
Matches the scope's equatorial coordinates to the given equatorial coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Declination", - "RightAscension" - ], - "type": "object", - "properties": { - "RightAscension": { - "type": "number", - "description": "Right Ascension coordinate (hours)", - "format": "double" - }, - "Declination": { - "type": "number", - "description": "Declination coordinate (degrees)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "RightAscension": { - "style": "form" - }, - "Declination": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/synctotarget": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Syncs to the TargetRightAscension and TargetDeclination coordinates.", - "description": "
Matches the scope's equatorial coordinates to the TargetRightAscension and TargetDeclination equatorial coordinates.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/targetdeclination": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current target declination.", - "description": "
The declination (degrees, positive North) for the target of an equatorial slew or sync operation", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the target declination of a slew or sync.", - "description": "
Sets the declination (degrees, positive North) for the target of an equatorial slew or sync operation", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "TargetDeclination" - ], - "type": "object", - "properties": { - "TargetDeclination": { - "type": "number", - "description": "Target declination(degrees)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "TargetDeclination": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/targetrightascension": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current target right ascension.", - "description": "
The right ascension (hours) for the target of an equatorial slew or sync operation", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DoubleResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the target right ascension of a slew or sync.", - "description": "
Sets the right ascension (hours) for the target of an equatorial slew or sync operation", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "TargetRightAscension" - ], - "type": "object", - "properties": { - "TargetRightAscension": { - "type": "number", - "description": "Target right ascension(hours)", - "format": "double" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "TargetRightAscension": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/tracking": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Indicates whether the telescope is tracking.", - "description": "
Returns the state of the telescope's sidereal tracking drive.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Enables or disables telescope tracking.", - "description": "
Sets the state of the telescope's sidereal tracking drive.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Tracking" - ], - "type": "object", - "properties": { - "Tracking": { - "type": "boolean", - "description": "Tracking enabled / disabled" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Tracking": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/trackingrate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the current tracking rate.", - "description": "
The current tracking rate of the telescope's sidereal drive.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the mount's tracking rate.", - "description": "
Sets the tracking rate of the telescope's sidereal drive. 0 = driveSidereal, 1 = driveLunar, 2 = driveSolar, 3 = driveKing", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "TrackingRate" - ], - "type": "object", - "properties": { - "TrackingRate": { - "type": "integer", - "description": "New tracking rate", - "format": "int32" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "TrackingRate": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/trackingrates": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns a collection of supported DriveRates values.", - "description": "
Returns an array of supported DriveRates values that describe the permissible values of the TrackingRate property for this telescope type.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DriveRatesResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/utcdate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the UTC date/time of the telescope's internal clock.", - "description": "
The UTC date/time of the telescope's internal clock in ISO 8601 format including fractional seconds. The general format (in Microsoft custom date format style) is yyyy-MM-ddTHH:mm:ss.fffffffZ E.g. 2016-03-04T17:45:31.1234567Z or 2016-11-14T07:03:08.1234567Z Please note the compulsory trailing Z indicating the 'Zulu', UTC time zone.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the UTC date/time of the telescope's internal clock.", - "description": "
The UTC date/time of the telescope's internal clock in ISO 8601 format including fractional seconds. The general format (in Microsoft custom date format style) is yyyy-MM-ddTHH:mm:ss.fffffffZ E.g. 2016-03-04T17:45:31.1234567Z or 2016-11-14T07:03:08.1234567Z Please note the compulsory trailing Z indicating the 'Zulu', UTC time zone.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "UTCDate" - ], - "type": "object", - "properties": { - "UTCDate": { - "type": "string", - "description": "UTC date/time in ISO 8601 format.", - "format": "date-time" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "UTCDate": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/unpark": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Unparks the mount.", - "description": "
Takes telescope out of the Parked state.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/connect": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Connect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/disconnect": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Disconnect to a device asynchronously", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/connecting": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns True while the device is undertaking an asynchronous connect or disconnect operation.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/devicestate": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the device operational state in a single call.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceStateResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/action": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Invokes the specified device-specific action.", - "description": "
Actions and SupportedActions are a standardised means for drivers to extend functionality beyond the built-in capabilities of the ASCOM device interfaces.\r\n
\r\n
The key advantage of using Actions is that drivers can expose any device specific functionality required. The downside is that, in order to use these unique features, every application author would need to create bespoke code to present or exploit them.\r\n
\r\n
The Action parameter and return strings are deceptively simple, but can support transmission of arbitrarily complex data structures, for example through JSON encoding.\r\n
\r\n
This capability will be of primary value to\r\n
\r\n
* bespoke software and hardware configurations where a single entity controls both the consuming application software and the hardware / driver environment\r\n
* a group of application and device authors to quickly formulate and try out new interface capabilities without requiring an immediate change to the ASCOM device interface, which will take a lot longer than just agreeing a name, input parameters and a standard response for an Action command.\r\n
\r\n
The list of Action commands supported by a driver can be discovered through the SupportedActions property.\r\n
\r\n
This method should return an error message and NotImplementedException error number (0x400) if the driver just implements the standard ASCOM device methods and has no bespoke, unique, functionality.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Action" - ], - "type": "object", - "properties": { - "Action": { - "type": "string", - "description": "A well known name that represents the action to be carried out." - }, - "Parameters": { - "type": "string", - "description": "List of required parameters or an Empty String if none are required.", - "default": "" - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Action": { - "style": "form" - }, - "Parameters": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/commandblind": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Transmits an arbitrary string to the device", - "description": "
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/commandbool": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Transmits an arbitrary string to the device and returns a boolean value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string", - "description": "The literal command string to be transmitted." - }, - "Raw": { - "type": "boolean", - "description": "If set to true the string is transmitted 'as-is', if set to false then protocol framing characters may be added prior to transmission.", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/commandstring": { - "put": { - "tags": [ - "Telescope" - ], - "summary": "Transmits an arbitrary string to the device and returns a string value from the device.", - "description": "
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Command" - ], - "type": "object", - "properties": { - "Command": { - "type": "string" - }, - "Raw": { - "type": "boolean", - "default": false - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Command": { - "style": "form" - }, - "Raw": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/connected": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Retrieves the connected state of the device", - "description": "
Retrieves the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoolResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - }, - "put": { - "tags": [ - "Telescope" - ], - "summary": "Sets the connected state of the device", - "description": "
Sets the connected state of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "Connected" - ], - "type": "object", - "properties": { - "Connected": { - "type": "boolean", - "description": "Set True to connect to the device hardware, set False to disconnect from the device hardware." - }, - "ClientID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - }, - "encoding": { - "Connected": { - "style": "form" - }, - "ClientID": { - "style": "form" - }, - "ClientTransactionID": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/description": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Device description", - "description": "
The description of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/driverinfo": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Device driver description", - "description": "
The description of the driver", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/driverversion": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Driver Version", - "description": "
A string containing only the major and minor version of the driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/interfaceversion": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "The ASCOM Device interface version number that this device supports.", - "description": "
This method returns the version of the ASCOM device interface contract to which this device complies. Only one interface version is current at a moment in time and all new devices should be built to the latest interface version. Applications can choose which device interface versions they support and it is in their interest to support previous versions as well as the current version to ensure they can use the largest number of devices.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/name": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Device name", - "description": "
The name of the device", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - }, - "/api/v1/telescope/{DeviceNumber}/supportedactions": { - "get": { - "tags": [ - "Telescope" - ], - "summary": "Returns the list of action names supported by this driver.", - "description": "
Returns the list of action names supported by this driver.", - "parameters": [ - { - "name": "DeviceNumber", - "in": "path", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "required": true, - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Zero based device number as set on the server (A uint32 with a range of 0 to 4294967295)", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientID", - "in": "query", - "description": "Client's unique ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's unique ID. (A uint32 with a range of 0 to 4294967295). The client should choose a value at start-up, e.g. a random value between 0 and 65535, and send this value on every transaction to help associate entries in device logs with this particular client.", - "format": "uint32", - "default": 0 - } - }, - { - "name": "ClientTransactionID", - "in": "query", - "description": "Client's transaction ID.", - "schema": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID. (0 to 4294967295). The client should start this count at 1 and increment by one on each successive transaction. This will aid associating entries in device logs with corresponding entries in client side logs.", - "format": "uint32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "Transaction complete or exception", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StringListResponse" - } - } - } - }, - "400": { - "description": "Method or parameter value error, check error message" - }, - "500": { - "description": "Server internal error, check error message" - } - } - } - } - }, - "components": { - "schemas": { - "AlpacaConfiguredDevice": { - "type": "object", - "properties": { - "DeviceName": { - "type": "string", - "description": "A short name for this device that a user would expect to see in a list of available devices.", - "nullable": true - }, - "DeviceType": { - "type": "string", - "description": "One of the supported ASCOM Devices types such as Telescope, Camera, Focuser etc.", - "nullable": true - }, - "DeviceNumber": { - "type": "integer", - "description": "The device number that must be used to access this device through the Alpaca Device API.", - "format": "int32" - }, - "UniqueID": { - "type": "string", - "description": "\"This should be the ProgID for COM devices or a GUID for native Alpaca devices.\"", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Returns an array of device description objects, providing unique information for each served device, enabling them to be accessed through the Alpaca Device API." - }, - "AlpacaConfiguredDevicesResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AlpacaConfiguredDevice" - }, - "description": "AlpacaConfiguredDevicesResponse value returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Class representing an Alpaca device's configured devices response" - }, - "AlpacaDescriptionResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "$ref": "#/components/schemas/AlpacaDeviceDescription" - } - }, - "additionalProperties": false, - "description": "The response for the AlpacaDeviceDescription" - }, - "AlpacaDeviceDescription": { - "type": "object", - "properties": { - "ServerName": { - "type": "string", - "description": "The device or server's overall name.", - "nullable": true - }, - "Manufacturer": { - "type": "string", - "description": "The manufacturer's name.", - "nullable": true - }, - "ManufacturerVersion": { - "type": "string", - "description": "The device or server's version number.", - "nullable": true - }, - "Location": { - "type": "string", - "description": "The device or server's location.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Returns cross-cutting information that applies to all devices available at this URL:Port." - }, - "AlpacaErrors": { - "enum": [ - 0, - 1024, - 1025, - 1026, - 1031, - 1032, - 1033, - 1035, - 1036, - 1038, - 1279, - 1280, - 4095 - ], - "type": "integer", - "description": "Error numbers for use by Alpaca applications and drivers in the range 0x400 to 0xFFF.", - "format": "int32" - }, - "ArrayType": { - "enum": [ - 0, - 1, - 2, - 3 - ], - "type": "integer", - "description": "Image array element type enumeration", - "format": "int32" - }, - "Assembly": { - "type": "object", - "properties": { - "DefinedTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TypeInfo" - }, - "nullable": true, - "readOnly": true - }, - "ExportedTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - }, - "CodeBase": { - "type": "string", - "nullable": true, - "readOnly": true, - "deprecated": true - }, - "EntryPoint": { - "$ref": "#/components/schemas/MethodInfo" - }, - "FullName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "ImageRuntimeVersion": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "IsDynamic": { - "type": "boolean", - "readOnly": true - }, - "Location": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "ReflectionOnly": { - "type": "boolean", - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "IsFullyTrusted": { - "type": "boolean", - "readOnly": true - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "EscapedCodeBase": { - "type": "string", - "nullable": true, - "readOnly": true, - "deprecated": true - }, - "ManifestModule": { - "$ref": "#/components/schemas/Module" - }, - "Modules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Module" - }, - "nullable": true, - "readOnly": true - }, - "GlobalAssemblyCache": { - "type": "boolean", - "readOnly": true, - "deprecated": true - }, - "HostContext": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "SecurityRuleSet": { - "$ref": "#/components/schemas/SecurityRuleSet" - } - }, - "additionalProperties": false - }, - "AxisRate": { - "type": "object", - "properties": { - "Minimum": { - "type": "number", - "description": "The minimum rate (degrees per second) This must always be a positive number. It indicates the maximum rate in either direction about the axis.", - "format": "double" - }, - "Maximum": { - "type": "number", - "description": "The maximum rate (degrees per second) This must always be a positive number. It indicates the maximum rate in either direction about the axis.", - "format": "double" - } - }, - "additionalProperties": false, - "description": "Describe a rate at which the telescope may be moved about the specified axis by the MoveAxis(TelescopeAxes, Double) method." - }, - "AxisRatesResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AxisRate" - }, - "description": "Axis rate collection returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a collection of ASCOM.Common.DeviceInterfaces.AxisRate values." - }, - "BoolResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "boolean", - "description": "Boolean value returned by the device" - } - }, - "additionalProperties": false, - "description": "Alpaca boolean response class" - }, - "CallingConventions": { - "enum": [ - 1, - 2, - 3, - 32, - 64 - ], - "type": "integer", - "format": "int32" - }, - "ConstructorInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "Attributes": { - "$ref": "#/components/schemas/MethodAttributes" - }, - "MethodImplementationFlags": { - "$ref": "#/components/schemas/MethodImplAttributes" - }, - "CallingConvention": { - "$ref": "#/components/schemas/CallingConventions" - }, - "IsAbstract": { - "type": "boolean", - "readOnly": true - }, - "IsConstructor": { - "type": "boolean", - "readOnly": true - }, - "IsFinal": { - "type": "boolean", - "readOnly": true - }, - "IsHideBySig": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsStatic": { - "type": "boolean", - "readOnly": true - }, - "IsVirtual": { - "type": "boolean", - "readOnly": true - }, - "IsAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamily": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyAndAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyOrAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsConstructedGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethodDefinition": { - "type": "boolean", - "readOnly": true - }, - "ContainsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "MethodHandle": { - "$ref": "#/components/schemas/RuntimeMethodHandle" - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - } - }, - "additionalProperties": false - }, - "CustomAttributeData": { - "type": "object", - "properties": { - "AttributeType": { - "$ref": "#/components/schemas/Type" - }, - "Constructor": { - "$ref": "#/components/schemas/ConstructorInfo" - }, - "ConstructorArguments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeTypedArgument" - }, - "nullable": true, - "readOnly": true - }, - "NamedArguments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeNamedArgument" - }, - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false - }, - "CustomAttributeNamedArgument": { - "type": "object", - "properties": { - "MemberInfo": { - "$ref": "#/components/schemas/MemberInfo" - }, - "TypedValue": { - "$ref": "#/components/schemas/CustomAttributeTypedArgument" - }, - "MemberName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "IsField": { - "type": "boolean", - "readOnly": true - } - }, - "additionalProperties": false - }, - "CustomAttributeTypedArgument": { - "type": "object", - "properties": { - "ArgumentType": { - "$ref": "#/components/schemas/Type" - }, - "Value": { - "nullable": true - } - }, - "additionalProperties": false - }, - "DeviceStateResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateValue" - }, - "description": "IStateValue collection returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a collection of IStateValue objects" - }, - "DoubleResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "number", - "description": "Double value returned by the device", - "format": "double" - } - }, - "additionalProperties": false, - "description": "Response that returns a double value." - }, - "DriveRate": { - "enum": [ - 0, - 1, - 2, - 3 - ], - "type": "integer", - "description": "Well-known telescope tracking rates.", - "format": "int32" - }, - "DriveRatesResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DriveRate" - }, - "description": "Drive rate collection returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a collection of ASCOM.Common.DeviceInterfaces.DriveRate values" - }, - "EventAttributes": { - "enum": [ - 0, - 512, - 1024 - ], - "type": "integer", - "format": "int32" - }, - "EventInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Attributes": { - "$ref": "#/components/schemas/EventAttributes" - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "AddMethod": { - "$ref": "#/components/schemas/MethodInfo" - }, - "RemoveMethod": { - "$ref": "#/components/schemas/MethodInfo" - }, - "RaiseMethod": { - "$ref": "#/components/schemas/MethodInfo" - }, - "IsMulticast": { - "type": "boolean", - "readOnly": true - }, - "EventHandlerType": { - "$ref": "#/components/schemas/Type" - } - }, - "additionalProperties": false - }, - "Exception": { - "type": "object", - "properties": { - "TargetSite": { - "$ref": "#/components/schemas/MethodBase" - }, - "Message": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "Data": { - "type": "object", - "additionalProperties": { }, - "nullable": true, - "readOnly": true - }, - "InnerException": { - "$ref": "#/components/schemas/Exception" - }, - "HelpLink": { - "type": "string", - "nullable": true - }, - "Source": { - "type": "string", - "nullable": true - }, - "HResult": { - "type": "integer", - "format": "int32" - }, - "StackTrace": { - "type": "string", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false - }, - "FieldAttributes": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 5, - 6, - 7, - 16, - 32, - 64, - 128, - 256, - 512, - 1024, - 4096, - 8192, - 32768, - 38144 - ], - "type": "integer", - "format": "int32" - }, - "FieldInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Attributes": { - "$ref": "#/components/schemas/FieldAttributes" - }, - "FieldType": { - "$ref": "#/components/schemas/Type" - }, - "IsInitOnly": { - "type": "boolean", - "readOnly": true - }, - "IsLiteral": { - "type": "boolean", - "readOnly": true - }, - "IsNotSerialized": { - "type": "boolean", - "readOnly": true, - "deprecated": true - }, - "IsPinvokeImpl": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsStatic": { - "type": "boolean", - "readOnly": true - }, - "IsAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamily": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyAndAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyOrAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "FieldHandle": { - "$ref": "#/components/schemas/RuntimeFieldHandle" - } - }, - "additionalProperties": false - }, - "GenericParameterAttributes": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 8, - 16, - 28 - ], - "type": "integer", - "format": "int32" - }, - "GuideDirection": { - "enum": [ - 0, - 1, - 2, - 3 - ], - "type": "integer", - "description": "The direction in which the guide-rate motion is to be made.", - "format": "int32" - }, - "ICustomAttributeProvider": { - "type": "object", - "additionalProperties": false - }, - "IntArray2DResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Type": { - "$ref": "#/components/schemas/ArrayType" - }, - "Rank": { - "type": "integer", - "description": "The array's rank, will be 2 (single plane image (monochrome)).", - "format": "int32", - "readOnly": true - }, - "Value": { - "type": "array", - "items": { }, - "description": "2D image array of int32 values", - "nullable": true - } - }, - "additionalProperties": false, - "description": "2 dimension image array response" - }, - "IntListResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "Integer collection returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a collection of integer values." - }, - "IntPtr": { - "type": "object", - "additionalProperties": false - }, - "IntResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "integer", - "description": "Integer value returned by the device", - "format": "int32" - } - }, - "additionalProperties": false, - "description": "Response that returns an integer value." - }, - "LayoutKind": { - "enum": [ - 0, - 2, - 3 - ], - "type": "integer", - "format": "int32" - }, - "MemberInfo": { - "type": "object", - "properties": { - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "additionalProperties": false - }, - "MemberTypes": { - "enum": [ - 1, - 2, - 4, - 8, - 16, - 32, - 64, - 128, - 191 - ], - "type": "integer", - "format": "int32" - }, - "MethodAttributes": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 5, - 6, - 7, - 8, - 16, - 32, - 64, - 128, - 256, - 512, - 1024, - 2048, - 4096, - 8192, - 16384, - 32768, - 53248 - ], - "type": "integer", - "format": "int32" - }, - "MethodBase": { - "type": "object", - "properties": { - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "Attributes": { - "$ref": "#/components/schemas/MethodAttributes" - }, - "MethodImplementationFlags": { - "$ref": "#/components/schemas/MethodImplAttributes" - }, - "CallingConvention": { - "$ref": "#/components/schemas/CallingConventions" - }, - "IsAbstract": { - "type": "boolean", - "readOnly": true - }, - "IsConstructor": { - "type": "boolean", - "readOnly": true - }, - "IsFinal": { - "type": "boolean", - "readOnly": true - }, - "IsHideBySig": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsStatic": { - "type": "boolean", - "readOnly": true - }, - "IsVirtual": { - "type": "boolean", - "readOnly": true - }, - "IsAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamily": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyAndAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyOrAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsConstructedGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethodDefinition": { - "type": "boolean", - "readOnly": true - }, - "ContainsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "MethodHandle": { - "$ref": "#/components/schemas/RuntimeMethodHandle" - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - } - }, - "additionalProperties": false - }, - "MethodImplAttributes": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 8, - 16, - 32, - 64, - 128, - 256, - 512, - 4096, - 65535 - ], - "type": "integer", - "format": "int32" - }, - "MethodInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "Attributes": { - "$ref": "#/components/schemas/MethodAttributes" - }, - "MethodImplementationFlags": { - "$ref": "#/components/schemas/MethodImplAttributes" - }, - "CallingConvention": { - "$ref": "#/components/schemas/CallingConventions" - }, - "IsAbstract": { - "type": "boolean", - "readOnly": true - }, - "IsConstructor": { - "type": "boolean", - "readOnly": true - }, - "IsFinal": { - "type": "boolean", - "readOnly": true - }, - "IsHideBySig": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsStatic": { - "type": "boolean", - "readOnly": true - }, - "IsVirtual": { - "type": "boolean", - "readOnly": true - }, - "IsAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamily": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyAndAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsFamilyOrAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsConstructedGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethod": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethodDefinition": { - "type": "boolean", - "readOnly": true - }, - "ContainsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "MethodHandle": { - "$ref": "#/components/schemas/RuntimeMethodHandle" - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "ReturnParameter": { - "$ref": "#/components/schemas/ParameterInfo" - }, - "ReturnType": { - "$ref": "#/components/schemas/Type" - }, - "ReturnTypeCustomAttributes": { - "$ref": "#/components/schemas/ICustomAttributeProvider" - } - }, - "additionalProperties": false - }, - "Module": { - "type": "object", - "properties": { - "Assembly": { - "$ref": "#/components/schemas/Assembly" - }, - "FullyQualifiedName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "MDStreamVersion": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "ModuleVersionId": { - "type": "string", - "format": "uuid", - "readOnly": true - }, - "ScopeName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "ModuleHandle": { - "$ref": "#/components/schemas/ModuleHandle" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "additionalProperties": false - }, - "ModuleHandle": { - "type": "object", - "properties": { - "MDStreamVersion": { - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "additionalProperties": false - }, - "ParameterAttributes": { - "enum": [ - 0, - 1, - 2, - 4, - 8, - 16, - 4096, - 8192, - 16384, - 32768, - 61440 - ], - "type": "integer", - "format": "int32" - }, - "ParameterInfo": { - "type": "object", - "properties": { - "Attributes": { - "$ref": "#/components/schemas/ParameterAttributes" - }, - "Member": { - "$ref": "#/components/schemas/MemberInfo" - }, - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "ParameterType": { - "$ref": "#/components/schemas/Type" - }, - "Position": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "IsIn": { - "type": "boolean", - "readOnly": true - }, - "IsLcid": { - "type": "boolean", - "readOnly": true - }, - "IsOptional": { - "type": "boolean", - "readOnly": true - }, - "IsOut": { - "type": "boolean", - "readOnly": true - }, - "IsRetval": { - "type": "boolean", - "readOnly": true - }, - "DefaultValue": { - "nullable": true, - "readOnly": true - }, - "RawDefaultValue": { - "nullable": true, - "readOnly": true - }, - "HasDefaultValue": { - "type": "boolean", - "readOnly": true - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "additionalProperties": false - }, - "PointingState": { - "enum": [ - 0, - 1, - -1 - ], - "type": "integer", - "description": "The pointing state of the mount", - "format": "int32" - }, - "PropertyAttributes": { - "enum": [ - 0, - 512, - 1024, - 4096, - 8192, - 16384, - 32768, - 62464 - ], - "type": "integer", - "format": "int32" - }, - "PropertyInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "PropertyType": { - "$ref": "#/components/schemas/Type" - }, - "Attributes": { - "$ref": "#/components/schemas/PropertyAttributes" - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "CanRead": { - "type": "boolean", - "readOnly": true - }, - "CanWrite": { - "type": "boolean", - "readOnly": true - }, - "GetMethod": { - "$ref": "#/components/schemas/MethodInfo" - }, - "SetMethod": { - "$ref": "#/components/schemas/MethodInfo" - } - }, - "additionalProperties": false - }, - "Response": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - } - }, - "additionalProperties": false, - "description": "Defines the properties that are common to all Alpaca responses." - }, - "RuntimeFieldHandle": { - "type": "object", - "properties": { - "Value": { - "$ref": "#/components/schemas/IntPtr" - } - }, - "additionalProperties": false - }, - "RuntimeMethodHandle": { - "type": "object", - "properties": { - "Value": { - "$ref": "#/components/schemas/IntPtr" - } - }, - "additionalProperties": false - }, - "RuntimeTypeHandle": { - "type": "object", - "properties": { - "Value": { - "$ref": "#/components/schemas/IntPtr" - } - }, - "additionalProperties": false - }, - "SecurityRuleSet": { - "enum": [ - 0, - 1, - 2 - ], - "type": "integer", - "format": "int32" - }, - "StateValue": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "description": "State name", - "nullable": true - }, - "Value": { - "description": "State value", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Class to hold a state name:value pair." - }, - "StringListResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "array", - "items": { - "type": "string" - }, - "description": "String collection returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a collection of strings" - }, - "StringResponse": { - "type": "object", - "properties": { - "ErrorNumber": { - "$ref": "#/components/schemas/AlpacaErrors" - }, - "ErrorMessage": { - "type": "string", - "description": "Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned,\r\na non zero ASCOM.Common.Alpaca.ErrorResponse.ErrorNumber must also be returned.", - "nullable": true - }, - "ClientTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.", - "format": "uint32" - }, - "ServerTransactionID": { - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "description": "Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.", - "format": "uint32" - }, - "Value": { - "type": "string", - "description": "String value returned by the device", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Response that returns a string value" - }, - "StructLayoutAttribute": { - "type": "object", - "properties": { - "TypeId": { - "nullable": true, - "readOnly": true - }, - "Value": { - "$ref": "#/components/schemas/LayoutKind" - } - }, - "additionalProperties": false - }, - "TelescopeAxis": { - "enum": [ - 0, - 1, - 2 - ], - "type": "integer", - "description": "The telescope axes", - "format": "int32" - }, - "Type": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "IsInterface": { - "type": "boolean", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Namespace": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "AssemblyQualifiedName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "FullName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "Assembly": { - "$ref": "#/components/schemas/Assembly" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "IsNested": { - "type": "boolean", - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "DeclaringMethod": { - "$ref": "#/components/schemas/MethodBase" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "UnderlyingSystemType": { - "$ref": "#/components/schemas/Type" - }, - "IsTypeDefinition": { - "type": "boolean", - "readOnly": true - }, - "IsArray": { - "type": "boolean", - "readOnly": true - }, - "IsByRef": { - "type": "boolean", - "readOnly": true - }, - "IsPointer": { - "type": "boolean", - "readOnly": true - }, - "IsConstructedGenericType": { - "type": "boolean", - "readOnly": true - }, - "IsGenericParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericTypeParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethodParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericType": { - "type": "boolean", - "readOnly": true - }, - "IsGenericTypeDefinition": { - "type": "boolean", - "readOnly": true - }, - "IsSZArray": { - "type": "boolean", - "readOnly": true - }, - "IsVariableBoundArray": { - "type": "boolean", - "readOnly": true - }, - "IsByRefLike": { - "type": "boolean", - "readOnly": true - }, - "IsFunctionPointer": { - "type": "boolean", - "readOnly": true - }, - "IsUnmanagedFunctionPointer": { - "type": "boolean", - "readOnly": true - }, - "HasElementType": { - "type": "boolean", - "readOnly": true - }, - "GenericTypeArguments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - }, - "GenericParameterPosition": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "GenericParameterAttributes": { - "$ref": "#/components/schemas/GenericParameterAttributes" - }, - "Attributes": { - "$ref": "#/components/schemas/TypeAttributes" - }, - "IsAbstract": { - "type": "boolean", - "readOnly": true - }, - "IsImport": { - "type": "boolean", - "readOnly": true - }, - "IsSealed": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsClass": { - "type": "boolean", - "readOnly": true - }, - "IsNestedAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamANDAssem": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamily": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamORAssem": { - "type": "boolean", - "readOnly": true - }, - "IsNestedPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsNestedPublic": { - "type": "boolean", - "readOnly": true - }, - "IsNotPublic": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsAutoLayout": { - "type": "boolean", - "readOnly": true - }, - "IsExplicitLayout": { - "type": "boolean", - "readOnly": true - }, - "IsLayoutSequential": { - "type": "boolean", - "readOnly": true - }, - "IsAnsiClass": { - "type": "boolean", - "readOnly": true - }, - "IsAutoClass": { - "type": "boolean", - "readOnly": true - }, - "IsUnicodeClass": { - "type": "boolean", - "readOnly": true - }, - "IsCOMObject": { - "type": "boolean", - "readOnly": true - }, - "IsContextful": { - "type": "boolean", - "readOnly": true - }, - "IsEnum": { - "type": "boolean", - "readOnly": true - }, - "IsMarshalByRef": { - "type": "boolean", - "readOnly": true - }, - "IsPrimitive": { - "type": "boolean", - "readOnly": true - }, - "IsValueType": { - "type": "boolean", - "readOnly": true - }, - "IsSignatureType": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "StructLayoutAttribute": { - "$ref": "#/components/schemas/StructLayoutAttribute" - }, - "TypeInitializer": { - "$ref": "#/components/schemas/ConstructorInfo" - }, - "TypeHandle": { - "$ref": "#/components/schemas/RuntimeTypeHandle" - }, - "GUID": { - "type": "string", - "format": "uuid", - "readOnly": true - }, - "BaseType": { - "$ref": "#/components/schemas/Type" - }, - "IsSerializable": { - "type": "boolean", - "readOnly": true, - "deprecated": true - }, - "ContainsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "IsVisible": { - "type": "boolean", - "readOnly": true - } - }, - "additionalProperties": false - }, - "TypeAttributes": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 5, - 6, - 7, - 8, - 16, - 24, - 32, - 128, - 256, - 1024, - 2048, - 4096, - 8192, - 16384, - 65536, - 131072, - 196608, - 262144, - 264192, - 1048576, - 12582912 - ], - "type": "integer", - "format": "int32" - }, - "TypeInfo": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "CustomAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeData" - }, - "nullable": true, - "readOnly": true - }, - "IsCollectible": { - "type": "boolean", - "readOnly": true - }, - "MetadataToken": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "IsInterface": { - "type": "boolean", - "readOnly": true - }, - "MemberType": { - "$ref": "#/components/schemas/MemberTypes" - }, - "Namespace": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "AssemblyQualifiedName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "FullName": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "Assembly": { - "$ref": "#/components/schemas/Assembly" - }, - "Module": { - "$ref": "#/components/schemas/Module" - }, - "IsNested": { - "type": "boolean", - "readOnly": true - }, - "DeclaringType": { - "$ref": "#/components/schemas/Type" - }, - "DeclaringMethod": { - "$ref": "#/components/schemas/MethodBase" - }, - "ReflectedType": { - "$ref": "#/components/schemas/Type" - }, - "UnderlyingSystemType": { - "$ref": "#/components/schemas/Type" - }, - "IsTypeDefinition": { - "type": "boolean", - "readOnly": true - }, - "IsArray": { - "type": "boolean", - "readOnly": true - }, - "IsByRef": { - "type": "boolean", - "readOnly": true - }, - "IsPointer": { - "type": "boolean", - "readOnly": true - }, - "IsConstructedGenericType": { - "type": "boolean", - "readOnly": true - }, - "IsGenericParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericTypeParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericMethodParameter": { - "type": "boolean", - "readOnly": true - }, - "IsGenericType": { - "type": "boolean", - "readOnly": true - }, - "IsGenericTypeDefinition": { - "type": "boolean", - "readOnly": true - }, - "IsSZArray": { - "type": "boolean", - "readOnly": true - }, - "IsVariableBoundArray": { - "type": "boolean", - "readOnly": true - }, - "IsByRefLike": { - "type": "boolean", - "readOnly": true - }, - "IsFunctionPointer": { - "type": "boolean", - "readOnly": true - }, - "IsUnmanagedFunctionPointer": { - "type": "boolean", - "readOnly": true - }, - "HasElementType": { - "type": "boolean", - "readOnly": true - }, - "GenericTypeArguments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - }, - "GenericParameterPosition": { - "type": "integer", - "format": "int32", - "readOnly": true - }, - "GenericParameterAttributes": { - "$ref": "#/components/schemas/GenericParameterAttributes" - }, - "Attributes": { - "$ref": "#/components/schemas/TypeAttributes" - }, - "IsAbstract": { - "type": "boolean", - "readOnly": true - }, - "IsImport": { - "type": "boolean", - "readOnly": true - }, - "IsSealed": { - "type": "boolean", - "readOnly": true - }, - "IsSpecialName": { - "type": "boolean", - "readOnly": true - }, - "IsClass": { - "type": "boolean", - "readOnly": true - }, - "IsNestedAssembly": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamANDAssem": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamily": { - "type": "boolean", - "readOnly": true - }, - "IsNestedFamORAssem": { - "type": "boolean", - "readOnly": true - }, - "IsNestedPrivate": { - "type": "boolean", - "readOnly": true - }, - "IsNestedPublic": { - "type": "boolean", - "readOnly": true - }, - "IsNotPublic": { - "type": "boolean", - "readOnly": true - }, - "IsPublic": { - "type": "boolean", - "readOnly": true - }, - "IsAutoLayout": { - "type": "boolean", - "readOnly": true - }, - "IsExplicitLayout": { - "type": "boolean", - "readOnly": true - }, - "IsLayoutSequential": { - "type": "boolean", - "readOnly": true - }, - "IsAnsiClass": { - "type": "boolean", - "readOnly": true - }, - "IsAutoClass": { - "type": "boolean", - "readOnly": true - }, - "IsUnicodeClass": { - "type": "boolean", - "readOnly": true - }, - "IsCOMObject": { - "type": "boolean", - "readOnly": true - }, - "IsContextful": { - "type": "boolean", - "readOnly": true - }, - "IsEnum": { - "type": "boolean", - "readOnly": true - }, - "IsMarshalByRef": { - "type": "boolean", - "readOnly": true - }, - "IsPrimitive": { - "type": "boolean", - "readOnly": true - }, - "IsValueType": { - "type": "boolean", - "readOnly": true - }, - "IsSignatureType": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecuritySafeCritical": { - "type": "boolean", - "readOnly": true - }, - "IsSecurityTransparent": { - "type": "boolean", - "readOnly": true - }, - "StructLayoutAttribute": { - "$ref": "#/components/schemas/StructLayoutAttribute" - }, - "TypeInitializer": { - "$ref": "#/components/schemas/ConstructorInfo" - }, - "TypeHandle": { - "$ref": "#/components/schemas/RuntimeTypeHandle" - }, - "GUID": { - "type": "string", - "format": "uuid", - "readOnly": true - }, - "BaseType": { - "$ref": "#/components/schemas/Type" - }, - "IsSerializable": { - "type": "boolean", - "readOnly": true, - "deprecated": true - }, - "ContainsGenericParameters": { - "type": "boolean", - "readOnly": true - }, - "IsVisible": { - "type": "boolean", - "readOnly": true - }, - "GenericTypeParameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredConstructors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConstructorInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredEvents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EventInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FieldInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredMembers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MemberInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MethodInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredNestedTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TypeInfo" - }, - "nullable": true, - "readOnly": true - }, - "DeclaredProperties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyInfo" - }, - "nullable": true, - "readOnly": true - }, - "ImplementedInterfaces": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Type" - }, - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false - } - } - } -} \ No newline at end of file diff --git a/templates/AlpycaDeviceSkeletons.code-workspace b/templates/AlpycaDeviceSkeletons.code-workspace deleted file mode 100644 index 876a149..0000000 --- a/templates/AlpycaDeviceSkeletons.code-workspace +++ /dev/null @@ -1,8 +0,0 @@ -{ - "folders": [ - { - "path": "." - } - ], - "settings": {} -} \ No newline at end of file diff --git a/templates/app.py b/templates/app.py deleted file mode 100644 index b98fc73..0000000 --- a/templates/app.py +++ /dev/null @@ -1,468 +0,0 @@ -# -*- coding: utf-8 -*- -# ----------------------------------------------------------------------------- -# app.py - Application module -# -# Python Interface Generator for AlpycaDevice -# -# Author: Robert B. Denny (rbd) -# -# Python Compatibility: Requires Python 3.7 or later -# -# ----------------------------------------------------------------------------- -# MIT License -# -# Copyright (c) 2022-2023 Bob Denny -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. -# ----------------------------------------------------------------------------- -# Edit History: -# 19-Jan-2023 rbd Initial edit -# 24-May-2023 rbd For upgraded templates with multi-device support -# 31-May-2023 Changes for Alpaca protocol conformance, and connected -# check in templates. Corrct capitalizaton of responder class names. -# Replace dunder naming with real names from YAML. Enhance to provide -# put paraeter handling with names and conversion functions that will -# raise an exception. Major upgrade to the templates. -# 08-Nov-2023 rbd GitHub #6 to_int and to_float are gone, remove from -# import statements from shr in module template. -# 08-Nov-2023 rbd GitHub #8 Include property Connected/ -# 08-Noc-2023 rbd Change other ommon property responder classes to -# lower case andremove redundant (). -# 08-Nov-2023 rbd GitHub #9 Corrections to avoid adding fragments -# of on_put() to existinv correct on_put(). -# 28-Nov-2023 rbd GitHub #9 Missing line and extra parenthesis in -# class Connected. Also substitute {memname} in mod_hdr -# to avoid naked {memhdr} in the templates. -# 14-Feb-2024 rbd Overhaul to use JSON instead of YAML, use the JSON -# from the Omni Simulator swagger for Platform 7 changes. -# 16-Feb-2024 rbd DeviceState has template code for construction -# 13-Sep-2024 rbd Add support for enum classes within the responder -# modules. These come from separate files not JSON. -# GitHub issue #12 -# 15-Sep-2024 rbd Fix handling of string parameters. Catch parameter -# types not supported here. -# 15-Sep-2024 rbd Fix multiple parameter related issues for both -# properties and methods. Add checks for incoming integer -# values for enums, fail if integer is not one of the -# values in the enum. This addresses GitHub issue #13 -# 16-Sep-2024 rbd InvalidValueException error messages now use -# f-strings instead of concatenation. -# 07-Jan-2025 rbd 1.1 use the new JSON input with the correct 'Id' casing for Switch. - -import json -import os.path - -mod_hdr = ''' -# -*- coding: utf-8 -*- -# -# ----------------------------------------------------------------------------- -# {devname}.py - Alpaca API responders for {Devname} -# -# Author: Your R. Name (abc) -# -# ----------------------------------------------------------------------------- -# Edit History: -# Generated by Python Interface Generator for AlpycaDevice -# -# ??-???-???? abc Initial edit - -from falcon import Request, Response, HTTPBadRequest, before -from logging import Logger -from shr import PropertyResponse, MethodResponse, PreProcessRequest, \\ - StateValue, get_request_field, to_bool -from exceptions import * # Nothing but exception classes - -logger: Logger = None - -# ---------------------- -# MULTI-INSTANCE SUPPORT -# ---------------------- -# If this is > 0 then it means that multiple devices of this type are supported. -# Each responder on_get() and on_put() is called with a devnum parameter to indicate -# which instance of the device (0-based) is being called by the client. Leave this -# set to 0 for the simple case of controlling only one instance of this device type. -# -maxdev = 0 # Single instance - -# ----------- -# DEVICE INFO -# ----------- -# Static metadata not subject to configuration changes -## EDIT FOR YOUR DEVICE ## -class {Devname}Metadata: - """ Metadata describing the {Devname} Device. Edit for your device""" - Name = 'Sample {Devname}' - Version = '##DRIVER VERSION AS STRING##' - Description = 'My ASCOM {Devname}' - DeviceType = '{Devname}' - DeviceID = '##GENERATE A NEW GUID AND PASTE HERE##' # https://guidgenerator.com/online-guid-generator.aspx - Info = 'Alpaca Sample Device\\nImplements I{Devname}\\nASCOM Initiative' - MaxDeviceNumber = maxdev - InterfaceVersion = ##YOUR DEVICE INTERFACE VERSION## # I{Devname}Vxxx - -{enum_block} -# -------------------- -# RESOURCE CONTROLLERS -# -------------------- - -@before(PreProcessRequest(maxdev)) -class action: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandblind: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandbool: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandstring: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class connect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------ - ### CONNECT THE DEVICE ### - # ------------------------ - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, '{Devname}.Connect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connected: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------------- - is_conn = ### READ CONN STATE ### - # ------------------------------------- - resp.text = PropertyResponse(is_conn, req).json - except Exception as ex: - resp.text = MethodResponse(req, DriverException(0x500, '{Devname}.Connected failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - conn_str = get_request_field('Connected', req) - conn = to_bool(conn_str) # Raises 400 Bad Request if str to bool fails - - try: - # -------------------------------------- - ### CONNECT OR DISCONNECT THE DEVICE ### - # -------------------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, # Put is actually like a method :-( - DriverException(0x500, '{Devname}.Connected failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connecting: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------ - val = ## GET CONNECTING STATE ## - # ------------------------------ - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, '{Devname}.Connecting failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class description: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse({Devname}Metadata.Description, req).json - -@before(PreProcessRequest(maxdev)) -class devicestate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # ---------------------- - val = [] - # val.append(StateValue('## NAME ##', ## GET VAL ##)) - # Repeat for each of the operational states per the device spec - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, '{devname}.Devicestate failed', ex)).json - - -class disconnect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # --------------------------- - ### DISCONNECT THE DEVICE ### - # --------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, '{Devname}.Disconnect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class driverinfo: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse({Devname}Metadata.Info, req).json - -@before(PreProcessRequest(maxdev)) -class interfaceversion: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse({Devname}Metadata.InterfaceVersion, req).json - -@before(PreProcessRequest(maxdev)) -class driverversion(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse({Devname}Metadata.Version, req).json - -@before(PreProcessRequest(maxdev)) -class name(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse({Devname}Metadata.Name, req).json - -@before(PreProcessRequest(maxdev)) -class supportedactions: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse([], req).json # Not PropertyNotImplemented - -''' -cls_tmpl = '''@before(PreProcessRequest(maxdev)) -class {memname}: - -''' - -get_tmpl = ''' def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - {GETPARAMS} - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, '{Devname}.{Memname} failed', ex)).json - -''' - -put_tmpl = ''' def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - {GETPARAMS} - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, '{Devname}.{Memname} failed', ex)).json - -''' - -params_tmpl_str = ''' - {param} = get_request_field('{Param}', req) # Raises 400 bad request if missing -''' - -params_tmpl_cvt = ''' - {param}str = get_request_field('{Param}', req) # Raises 400 bad request if missing - try: - {param} = {cvtfunc}({param}str) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'{Param} {{param}str} not a valid {ptype}.')).json - return -''' - -# Only valid for integer enums -params_tmpl_enum = ''' - {param}str = get_request_field('{Param}', req) # Raises 400 bad request if missing - try: - {param} = int({param}str) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'{Param} {{param}str} not a valid integer.')).json - return - if not {param} in {enumvals}: - resp.text = MethodResponse(req, - InvalidValueException(f'{Param} {{param}} not a valid enum value.')).json - return -''' - - -# Skip these common members, they are in the device main template -common_mems = ['action', 'commandblind', 'commandbool', 'commandstring', 'connect', 'connected', 'connecting', - 'devicestate', 'description', 'disconnect', 'driverinfo', 'driverversion', 'interfaceversion', - 'name', 'supportedactions'] - -def main(): - with open('AlpacaDeviceAPI_v2_plat7-0.4.1.json') as f: # Has corrected 'Id' casing for Switch - toptree = json.load(f) - - seendevs = [] - mf = None - - for path, meths in toptree['paths'].items(): - print(f'{path}') - bits = path.split('/') - if bits[1] == 'management' or bits[1] == 'simulator': - continue - devname = bits[3] - Devname = devname.title() - memname = bits[5] - Memname = memname.title() - if memname in common_mems: - continue; - if not devname in seendevs: - if not mf is None and not mf.closed: - mf.close - mf = open(f'{devname}.py', 'w') - temp = mod_hdr.replace('{devname}', devname) - if os.path.exists(f'enum/{devname}_enum.py'): - ef = open(f'enum/{devname}_enum.py') - enumtxt = ef.read() - ef.close() - temp = temp.replace('{enum_block}', enumtxt) - else: - temp = temp.replace('{enum_block}', '') - mf.write(temp.replace('{Devname}', Devname)) - seendevs.append(devname) - mf.write(cls_tmpl.replace('{memname}', memname)) - for meth, meta in meths.items(): - # TODO -- Yes I know this can be refactored! TFB - if meth == 'get': - temp = get_tmpl.replace('{Devname}', Devname) - temp = temp.replace('{Memname}', Memname) - getparams = '' - for param in meths['get']['parameters']: - Pname = param['name'] - pname = Pname.lower() - if pname == 'clientid' or pname == 'clienttransactionid' or pname == 'devicenumber': - continue; - if '$ref' in param['schema']: - ref = param['schema']['$ref'].split('/')[3] # Enum NAME - refdict = toptree['components']['schemas'][ref] - ptype = refdict['type'] # Data type of enum - if ptype != 'integer': - raise Exception('Oops enum with non-integer values') - if 'enum' in refdict: - ptype = 'enum' # Enum parameter template range check - enumvals = refdict['enum'] # List of valid integer values - else: - raise Exception('Oops, $ref of type other than enum') - #{'enum': [0, 1, 2], 'type': 'integer', 'description': 'The telescope axes', 'format': 'int32'} - else: - ptype = param['schema']['type'] - if ptype == 'string': - ptemp = params_tmpl_str - ptemp += ' ### INTEPRET AS NEEDED OR FAIL ### # Raise Alpaca InvalidValueException with details!' - elif ptype == 'boolean': - ptemp = params_tmpl_cvt - ptemp = ptemp.replace('{cvtfunc}', 'to_bool') - elif ptype == 'integer': - ptemp = params_tmpl_cvt - ptemp = ptemp.replace('{cvtfunc}', 'int') - ptemp += ' ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details!' - elif ptype == 'number': - ptemp = params_tmpl_cvt - ptemp = ptemp.replace('{cvtfunc}', 'float') - ptemp += ' ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details!' - elif ptype == 'enum': - ptemp = params_tmpl_enum - ptemp = ptemp.replace('{enumvals}', str(enumvals)) - else: - raise Exception('Unsupported parameter type {ptype}') - ptemp = ptemp.replace('{param}', pname) # Parameter name - ptemp = ptemp.replace('{Param}', Pname) - ptemp = ptemp.replace('{ptype}', ptype) - getparams += ptemp - #mf.write('#------ 1 ------\n') # Direct RequestBody with parameters - mf.write (temp.replace('{GETPARAMS}', getparams)) - else: - temp = put_tmpl.replace('{Devname}', Devname) - temp = temp.replace('{Memname}', Memname) - getparams = '' - if 'content' in meths['put']['requestBody']: - for param in meths['put']['requestBody']['content']['multipart/form-data']['schema']['properties'].items(): - Pname = param[0] - pname = Pname.lower() - if pname == 'clientid' or pname == 'clienttransactionid': - continue; - if '$ref' in param[1]: - ref = param[1]['$ref'].split('/')[3] - refdict = toptree['components']['schemas'][ref] - ptype = refdict['type'] # Data type of enum - if ptype != 'integer': - raise Exception('Oops enum with non-integer values') - if 'enum' in refdict: - ptype = 'enum' # Enum parameter template range check - enumvals = refdict['enum'] # List of valid integer values - else: - raise Exception('Oops, $ref of type other than enum') - else: - ptype = param[1]['type'] - if ptype == 'string': - ptemp = params_tmpl_str - ptemp += ' ### INTEPRET AS NEEDED OR FAIL ### # Raise Alpaca InvalidValueException with details!' - elif ptype == 'boolean': - ptemp = params_tmpl_cvt - ptemp = ptemp.replace('{cvtfunc}', 'to_bool') - elif ptype == 'integer': - ptemp = params_tmpl_cvt - ptemp = ptemp.replace('{cvtfunc}', 'int') - ptemp += ' ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details!' - elif ptype == 'number': - ptemp = params_tmpl_cvt - ptemp = ptemp.replace('{cvtfunc}', 'float') - ptemp += ' ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details!' - elif ptype == 'enum': - ptemp = params_tmpl_enum - ptemp = ptemp.replace('{enumvals}', str(enumvals)) - else: - raise Exception('Unsupported parameter type {ptype}') - ptemp = ptemp.replace('{param}', pname) # Parameter name - ptemp = ptemp.replace('{Param}', Pname) - ptemp = ptemp.replace('{ptype}', ptype) - - getparams += ptemp - #mf.write('#------ 1 ------\n') # Direct RequestBody with parameters - mf.write (temp.replace('{GETPARAMS}', getparams)) - - mf.close() - print('end') - - -# ======================== -if __name__ == '__main__': - main() -# ======================== diff --git a/templates/camera.py b/templates/camera.py deleted file mode 100644 index 111ed98..0000000 --- a/templates/camera.py +++ /dev/null @@ -1,1611 +0,0 @@ - -# -*- coding: utf-8 -*- -# -# ----------------------------------------------------------------------------- -# camera.py - Alpaca API responders for Camera -# -# Author: Your R. Name (abc) -# -# ----------------------------------------------------------------------------- -# Edit History: -# Generated by Python Interface Generator for AlpycaDevice -# -# ??-???-???? abc Initial edit - -from falcon import Request, Response, HTTPBadRequest, before -from logging import Logger -from shr import PropertyResponse, MethodResponse, PreProcessRequest, \ - StateValue, get_request_field, to_bool -from exceptions import * # Nothing but exception classes - -logger: Logger = None - -# ---------------------- -# MULTI-INSTANCE SUPPORT -# ---------------------- -# If this is > 0 then it means that multiple devices of this type are supported. -# Each responder on_get() and on_put() is called with a devnum parameter to indicate -# which instance of the device (0-based) is being called by the client. Leave this -# set to 0 for the simple case of controlling only one instance of this device type. -# -maxdev = 0 # Single instance - -# ----------- -# DEVICE INFO -# ----------- -# Static metadata not subject to configuration changes -## EDIT FOR YOUR DEVICE ## -class CameraMetadata: - """ Metadata describing the Camera Device. Edit for your device""" - Name = 'Sample Camera' - Version = '##DRIVER VERSION AS STRING##' - Description = 'My ASCOM Camera' - DeviceType = 'Camera' - DeviceID = '##GENERATE A NEW GUID AND PASTE HERE##' # https://guidgenerator.com/online-guid-generator.aspx - Info = 'Alpaca Sample Device\nImplements ICamera\nASCOM Initiative' - MaxDeviceNumber = maxdev - InterfaceVersion = ##YOUR DEVICE INTERFACE VERSION## # ICameraVxxx - -# -------------- -# SYMBOLIC ENUMS -# -------------- -# -from enum import IntEnum - -class CameraStates(IntEnum): - cameraIdle = 0, - cameraWaiting = 1, - cameraExposing = 2, - cameraReading = 3, - cameraDownload = 4, - cameraError = 5 - -class SensorType(IntEnum): - Monochrome = 0, - Color = 1, - RGGB = 2, - CMYG = 3, - CMYG2 = 4, - LRGB = 5 - -class ImageArrayElementTypes(IntEnum): - Unknown = 0 - Int16 = 1 - Int32 = 2 - Double = 3 - Single = 4, - UInt64 = 5, - Byte = 6, - Int64 = 7, - UInt16 = 8 - -# -------------------- -# RESOURCE CONTROLLERS -# -------------------- - -@before(PreProcessRequest(maxdev)) -class action: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandblind: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandbool: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandstring: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class connect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------ - ### CONNECT THE DEVICE ### - # ------------------------ - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Connect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connected: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------------- - is_conn = ### READ CONN STATE ### - # ------------------------------------- - resp.text = PropertyResponse(is_conn, req).json - except Exception as ex: - resp.text = MethodResponse(req, DriverException(0x500, 'Camera.Connected failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - conn_str = get_request_field('Connected', req) - conn = to_bool(conn_str) # Raises 400 Bad Request if str to bool fails - - try: - # -------------------------------------- - ### CONNECT OR DISCONNECT THE DEVICE ### - # -------------------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, # Put is actually like a method :-( - DriverException(0x500, 'Camera.Connected failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connecting: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------ - val = ## GET CONNECTING STATE ## - # ------------------------------ - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Connecting failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class description: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(CameraMetadata.Description, req).json - -@before(PreProcessRequest(maxdev)) -class devicestate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # ---------------------- - val = [] - # val.append(StateValue('## NAME ##', ## GET VAL ##)) - # Repeat for each of the operational states per the device spec - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'camera.Devicestate failed', ex)).json - - -class disconnect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # --------------------------- - ### DISCONNECT THE DEVICE ### - # --------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Disconnect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class driverinfo: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(CameraMetadata.Info, req).json - -@before(PreProcessRequest(maxdev)) -class interfaceversion: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(CameraMetadata.InterfaceVersion, req).json - -@before(PreProcessRequest(maxdev)) -class driverversion(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(CameraMetadata.Version, req).json - -@before(PreProcessRequest(maxdev)) -class name(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(CameraMetadata.Name, req).json - -@before(PreProcessRequest(maxdev)) -class supportedactions: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse([], req).json # Not PropertyNotImplemented - -@before(PreProcessRequest(maxdev)) -class bayeroffsetx: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Bayeroffsetx failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class bayeroffsety: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Bayeroffsety failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class binx: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Binx failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - binxstr = get_request_field('BinX', req) # Raises 400 bad request if missing - try: - binx = int(binxstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'BinX {binxstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Binx failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class biny: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Biny failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - binystr = get_request_field('BinY', req) # Raises 400 bad request if missing - try: - biny = int(binystr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'BinY {binystr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Biny failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class camerastate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Camerastate failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cameraxsize: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Cameraxsize failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cameraysize: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Cameraysize failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canabortexposure: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Canabortexposure failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canasymmetricbin: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Canasymmetricbin failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canfastreadout: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Canfastreadout failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cangetcoolerpower: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Cangetcoolerpower failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canpulseguide: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Canpulseguide failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cansetccdtemperature: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Cansetccdtemperature failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canstopexposure: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Canstopexposure failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class ccdtemperature: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Ccdtemperature failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cooleron: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Cooleron failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - cooleronstr = get_request_field('CoolerOn', req) # Raises 400 bad request if missing - try: - cooleron = to_bool(cooleronstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'CoolerOn {cooleronstr} not a valid boolean.')).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Cooleron failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class coolerpower: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Coolerpower failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class electronsperadu: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Electronsperadu failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class exposuremax: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Exposuremax failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class exposuremin: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Exposuremin failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class exposureresolution: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Exposureresolution failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class fastreadout: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Fastreadout failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - fastreadoutstr = get_request_field('FastReadout', req) # Raises 400 bad request if missing - try: - fastreadout = to_bool(fastreadoutstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'FastReadout {fastreadoutstr} not a valid boolean.')).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Fastreadout failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class fullwellcapacity: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Fullwellcapacity failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class gain: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Gain failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - gainstr = get_request_field('Gain', req) # Raises 400 bad request if missing - try: - gain = int(gainstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Gain {gainstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Gain failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class gainmax: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Gainmax failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class gainmin: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Gainmin failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class gains: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Gains failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class hasshutter: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Hasshutter failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class heatsinktemperature: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Heatsinktemperature failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class imagearray: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Imagearray failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class imagearrayvariant: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Imagearrayvariant failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class imageready: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Imageready failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class ispulseguiding: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Ispulseguiding failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class lastexposureduration: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Lastexposureduration failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class lastexposurestarttime: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Lastexposurestarttime failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class maxadu: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Maxadu failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class maxbinx: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Maxbinx failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class maxbiny: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Maxbiny failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class numx: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Numx failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - numxstr = get_request_field('NumX', req) # Raises 400 bad request if missing - try: - numx = int(numxstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'NumX {numxstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Numx failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class numy: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Numy failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - numystr = get_request_field('NumY', req) # Raises 400 bad request if missing - try: - numy = int(numystr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'NumY {numystr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Numy failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class offset: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Offset failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - offsetstr = get_request_field('Offset', req) # Raises 400 bad request if missing - try: - offset = int(offsetstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Offset {offsetstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Offset failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class offsetmax: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Offsetmax failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class offsetmin: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Offsetmin failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class offsets: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Offsets failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class percentcompleted: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Percentcompleted failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class pixelsizex: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Pixelsizex failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class pixelsizey: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Pixelsizey failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class readoutmode: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Readoutmode failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - readoutmodestr = get_request_field('ReadoutMode', req) # Raises 400 bad request if missing - try: - readoutmode = int(readoutmodestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'ReadoutMode {readoutmodestr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Readoutmode failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class readoutmodes: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Readoutmodes failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class sensorname: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Sensorname failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class sensortype: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Sensortype failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class setccdtemperature: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Setccdtemperature failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - setccdtemperaturestr = get_request_field('SetCCDTemperature', req) # Raises 400 bad request if missing - try: - setccdtemperature = float(setccdtemperaturestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'SetCCDTemperature {setccdtemperaturestr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Setccdtemperature failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class startx: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Startx failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - startxstr = get_request_field('StartX', req) # Raises 400 bad request if missing - try: - startx = int(startxstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'StartX {startxstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Startx failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class starty: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Starty failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - startystr = get_request_field('StartY', req) # Raises 400 bad request if missing - try: - starty = int(startystr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'StartY {startystr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Starty failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class subexposureduration: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Camera.Subexposureduration failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - subexposuredurationstr = get_request_field('SubExposureDuration', req) # Raises 400 bad request if missing - try: - subexposureduration = float(subexposuredurationstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'SubExposureDuration {subexposuredurationstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Subexposureduration failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class abortexposure: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Abortexposure failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class pulseguide: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - directionstr = get_request_field('Direction', req) # Raises 400 bad request if missing - try: - direction = int(directionstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Direction {directionstr} not a valid integer.')).json - return - if not direction in [0, 1, 2, 3]: - resp.text = MethodResponse(req, - InvalidValueException(f'Direction {direction} not a valid enum value.')).json - return - - durationstr = get_request_field('Duration', req) # Raises 400 bad request if missing - try: - duration = int(durationstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Duration {durationstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Pulseguide failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class startexposure: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - durationstr = get_request_field('Duration', req) # Raises 400 bad request if missing - try: - duration = float(durationstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Duration {durationstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - lightstr = get_request_field('Light', req) # Raises 400 bad request if missing - try: - light = to_bool(lightstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Light {lightstr} not a valid boolean.')).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Startexposure failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class stopexposure: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Camera.Stopexposure failed', ex)).json - diff --git a/templates/covercalibrator.py b/templates/covercalibrator.py deleted file mode 100644 index d3e4364..0000000 --- a/templates/covercalibrator.py +++ /dev/null @@ -1,409 +0,0 @@ - -# -*- coding: utf-8 -*- -# -# ----------------------------------------------------------------------------- -# covercalibrator.py - Alpaca API responders for Covercalibrator -# -# Author: Your R. Name (abc) -# -# ----------------------------------------------------------------------------- -# Edit History: -# Generated by Python Interface Generator for AlpycaDevice -# -# ??-???-???? abc Initial edit - -from falcon import Request, Response, HTTPBadRequest, before -from logging import Logger -from shr import PropertyResponse, MethodResponse, PreProcessRequest, \ - StateValue, get_request_field, to_bool -from exceptions import * # Nothing but exception classes - -logger: Logger = None - -# ---------------------- -# MULTI-INSTANCE SUPPORT -# ---------------------- -# If this is > 0 then it means that multiple devices of this type are supported. -# Each responder on_get() and on_put() is called with a devnum parameter to indicate -# which instance of the device (0-based) is being called by the client. Leave this -# set to 0 for the simple case of controlling only one instance of this device type. -# -maxdev = 0 # Single instance - -# ----------- -# DEVICE INFO -# ----------- -# Static metadata not subject to configuration changes -## EDIT FOR YOUR DEVICE ## -class CovercalibratorMetadata: - """ Metadata describing the Covercalibrator Device. Edit for your device""" - Name = 'Sample Covercalibrator' - Version = '##DRIVER VERSION AS STRING##' - Description = 'My ASCOM Covercalibrator' - DeviceType = 'Covercalibrator' - DeviceID = '##GENERATE A NEW GUID AND PASTE HERE##' # https://guidgenerator.com/online-guid-generator.aspx - Info = 'Alpaca Sample Device\nImplements ICovercalibrator\nASCOM Initiative' - MaxDeviceNumber = maxdev - InterfaceVersion = ##YOUR DEVICE INTERFACE VERSION## # ICovercalibratorVxxx - -# -------------- -# SYMBOLIC ENUMS -# -------------- -# -from enum import IntEnum - -class CalibratorStatus(IntEnum): - NotPresent = 0, - Off = 1, - NotReady = 2, - Ready = 3, - Unknown = 4, - Error = 5 - -class CoverStatus(IntEnum): - NotPresent = 0, - Closed = 1, - Moving = 2, - Open = 3, - Unknown = 4, - Error = 5 - -# -------------------- -# RESOURCE CONTROLLERS -# -------------------- - -@before(PreProcessRequest(maxdev)) -class action: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandblind: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandbool: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandstring: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class connect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------ - ### CONNECT THE DEVICE ### - # ------------------------ - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Covercalibrator.Connect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connected: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------------- - is_conn = ### READ CONN STATE ### - # ------------------------------------- - resp.text = PropertyResponse(is_conn, req).json - except Exception as ex: - resp.text = MethodResponse(req, DriverException(0x500, 'Covercalibrator.Connected failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - conn_str = get_request_field('Connected', req) - conn = to_bool(conn_str) # Raises 400 Bad Request if str to bool fails - - try: - # -------------------------------------- - ### CONNECT OR DISCONNECT THE DEVICE ### - # -------------------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, # Put is actually like a method :-( - DriverException(0x500, 'Covercalibrator.Connected failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connecting: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------ - val = ## GET CONNECTING STATE ## - # ------------------------------ - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Covercalibrator.Connecting failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class description: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(CovercalibratorMetadata.Description, req).json - -@before(PreProcessRequest(maxdev)) -class devicestate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # ---------------------- - val = [] - # val.append(StateValue('## NAME ##', ## GET VAL ##)) - # Repeat for each of the operational states per the device spec - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'covercalibrator.Devicestate failed', ex)).json - - -class disconnect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # --------------------------- - ### DISCONNECT THE DEVICE ### - # --------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Covercalibrator.Disconnect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class driverinfo: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(CovercalibratorMetadata.Info, req).json - -@before(PreProcessRequest(maxdev)) -class interfaceversion: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(CovercalibratorMetadata.InterfaceVersion, req).json - -@before(PreProcessRequest(maxdev)) -class driverversion(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(CovercalibratorMetadata.Version, req).json - -@before(PreProcessRequest(maxdev)) -class name(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(CovercalibratorMetadata.Name, req).json - -@before(PreProcessRequest(maxdev)) -class supportedactions: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse([], req).json # Not PropertyNotImplemented - -@before(PreProcessRequest(maxdev)) -class brightness: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Covercalibrator.Brightness failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class calibratorchanging: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Covercalibrator.Calibratorchanging failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class calibratorstate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Covercalibrator.Calibratorstate failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class covermoving: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Covercalibrator.Covermoving failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class coverstate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Covercalibrator.Coverstate failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class maxbrightness: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Covercalibrator.Maxbrightness failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class calibratoroff: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Covercalibrator.Calibratoroff failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class calibratoron: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - brightnessstr = get_request_field('Brightness', req) # Raises 400 bad request if missing - try: - brightness = int(brightnessstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Brightness {brightnessstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Covercalibrator.Calibratoron failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class closecover: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Covercalibrator.Closecover failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class haltcover: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Covercalibrator.Haltcover failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class opencover: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Covercalibrator.Opencover failed', ex)).json - diff --git a/templates/dome.py b/templates/dome.py deleted file mode 100644 index ec487bf..0000000 --- a/templates/dome.py +++ /dev/null @@ -1,673 +0,0 @@ - -# -*- coding: utf-8 -*- -# -# ----------------------------------------------------------------------------- -# dome.py - Alpaca API responders for Dome -# -# Author: Your R. Name (abc) -# -# ----------------------------------------------------------------------------- -# Edit History: -# Generated by Python Interface Generator for AlpycaDevice -# -# ??-???-???? abc Initial edit - -from falcon import Request, Response, HTTPBadRequest, before -from logging import Logger -from shr import PropertyResponse, MethodResponse, PreProcessRequest, \ - StateValue, get_request_field, to_bool -from exceptions import * # Nothing but exception classes - -logger: Logger = None - -# ---------------------- -# MULTI-INSTANCE SUPPORT -# ---------------------- -# If this is > 0 then it means that multiple devices of this type are supported. -# Each responder on_get() and on_put() is called with a devnum parameter to indicate -# which instance of the device (0-based) is being called by the client. Leave this -# set to 0 for the simple case of controlling only one instance of this device type. -# -maxdev = 0 # Single instance - -# ----------- -# DEVICE INFO -# ----------- -# Static metadata not subject to configuration changes -## EDIT FOR YOUR DEVICE ## -class DomeMetadata: - """ Metadata describing the Dome Device. Edit for your device""" - Name = 'Sample Dome' - Version = '##DRIVER VERSION AS STRING##' - Description = 'My ASCOM Dome' - DeviceType = 'Dome' - DeviceID = '##GENERATE A NEW GUID AND PASTE HERE##' # https://guidgenerator.com/online-guid-generator.aspx - Info = 'Alpaca Sample Device\nImplements IDome\nASCOM Initiative' - MaxDeviceNumber = maxdev - InterfaceVersion = ##YOUR DEVICE INTERFACE VERSION## # IDomeVxxx - -# -------------- -# SYMBOLIC ENUMS -# -------------- -# -from enum import IntEnum - -class ShutterState(IntEnum): - shutterOpen = 0, - shutterClosed = 1, - shutterOpening = 2, - shutterClosing = 3, - shutterError = 4 - -# -------------------- -# RESOURCE CONTROLLERS -# -------------------- - -@before(PreProcessRequest(maxdev)) -class action: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandblind: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandbool: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandstring: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class connect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------ - ### CONNECT THE DEVICE ### - # ------------------------ - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Dome.Connect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connected: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------------- - is_conn = ### READ CONN STATE ### - # ------------------------------------- - resp.text = PropertyResponse(is_conn, req).json - except Exception as ex: - resp.text = MethodResponse(req, DriverException(0x500, 'Dome.Connected failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - conn_str = get_request_field('Connected', req) - conn = to_bool(conn_str) # Raises 400 Bad Request if str to bool fails - - try: - # -------------------------------------- - ### CONNECT OR DISCONNECT THE DEVICE ### - # -------------------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, # Put is actually like a method :-( - DriverException(0x500, 'Dome.Connected failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connecting: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------ - val = ## GET CONNECTING STATE ## - # ------------------------------ - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Dome.Connecting failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class description: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(DomeMetadata.Description, req).json - -@before(PreProcessRequest(maxdev)) -class devicestate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # ---------------------- - val = [] - # val.append(StateValue('## NAME ##', ## GET VAL ##)) - # Repeat for each of the operational states per the device spec - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'dome.Devicestate failed', ex)).json - - -class disconnect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # --------------------------- - ### DISCONNECT THE DEVICE ### - # --------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Dome.Disconnect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class driverinfo: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(DomeMetadata.Info, req).json - -@before(PreProcessRequest(maxdev)) -class interfaceversion: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(DomeMetadata.InterfaceVersion, req).json - -@before(PreProcessRequest(maxdev)) -class driverversion(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(DomeMetadata.Version, req).json - -@before(PreProcessRequest(maxdev)) -class name(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(DomeMetadata.Name, req).json - -@before(PreProcessRequest(maxdev)) -class supportedactions: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse([], req).json # Not PropertyNotImplemented - -@before(PreProcessRequest(maxdev)) -class altitude: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Dome.Altitude failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class athome: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Dome.Athome failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class atpark: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Dome.Atpark failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class azimuth: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Dome.Azimuth failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canfindhome: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Dome.Canfindhome failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canpark: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Dome.Canpark failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cansetaltitude: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Dome.Cansetaltitude failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cansetazimuth: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Dome.Cansetazimuth failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cansetpark: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Dome.Cansetpark failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cansetshutter: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Dome.Cansetshutter failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canslave: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Dome.Canslave failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cansyncazimuth: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Dome.Cansyncazimuth failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class shutterstatus: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Dome.Shutterstatus failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class slaved: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Dome.Slaved failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - slavedstr = get_request_field('Slaved', req) # Raises 400 bad request if missing - try: - slaved = to_bool(slavedstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Slaved {slavedstr} not a valid boolean.')).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Dome.Slaved failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class slewing: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Dome.Slewing failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class abortslew: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Dome.Abortslew failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class closeshutter: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Dome.Closeshutter failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class findhome: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Dome.Findhome failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class openshutter: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Dome.Openshutter failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class park: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Dome.Park failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class setpark: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Dome.Setpark failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class slewtoaltitude: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - altitudestr = get_request_field('Altitude', req) # Raises 400 bad request if missing - try: - altitude = float(altitudestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Altitude {altitudestr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Dome.Slewtoaltitude failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class slewtoazimuth: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - azimuthstr = get_request_field('Azimuth', req) # Raises 400 bad request if missing - try: - azimuth = float(azimuthstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Azimuth {azimuthstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Dome.Slewtoazimuth failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class synctoazimuth: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - azimuthstr = get_request_field('Azimuth', req) # Raises 400 bad request if missing - try: - azimuth = float(azimuthstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Azimuth {azimuthstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Dome.Synctoazimuth failed', ex)).json - diff --git a/templates/enum/camera_enum.py b/templates/enum/camera_enum.py deleted file mode 100644 index 796353a..0000000 --- a/templates/enum/camera_enum.py +++ /dev/null @@ -1,32 +0,0 @@ -# -------------- -# SYMBOLIC ENUMS -# -------------- -# -from enum import IntEnum - -class CameraStates(IntEnum): - cameraIdle = 0, - cameraWaiting = 1, - cameraExposing = 2, - cameraReading = 3, - cameraDownload = 4, - cameraError = 5 - -class SensorType(IntEnum): - Monochrome = 0, - Color = 1, - RGGB = 2, - CMYG = 3, - CMYG2 = 4, - LRGB = 5 - -class ImageArrayElementTypes(IntEnum): - Unknown = 0 - Int16 = 1 - Int32 = 2 - Double = 3 - Single = 4, - UInt64 = 5, - Byte = 6, - Int64 = 7, - UInt16 = 8 diff --git a/templates/enum/covercalibrator_enum.py b/templates/enum/covercalibrator_enum.py deleted file mode 100644 index 578c9f1..0000000 --- a/templates/enum/covercalibrator_enum.py +++ /dev/null @@ -1,21 +0,0 @@ -# -------------- -# SYMBOLIC ENUMS -# -------------- -# -from enum import IntEnum - -class CalibratorStatus(IntEnum): - NotPresent = 0, - Off = 1, - NotReady = 2, - Ready = 3, - Unknown = 4, - Error = 5 - -class CoverStatus(IntEnum): - NotPresent = 0, - Closed = 1, - Moving = 2, - Open = 3, - Unknown = 4, - Error = 5 diff --git a/templates/enum/dome_enum.py b/templates/enum/dome_enum.py deleted file mode 100644 index 00cc5fb..0000000 --- a/templates/enum/dome_enum.py +++ /dev/null @@ -1,12 +0,0 @@ -# -------------- -# SYMBOLIC ENUMS -# -------------- -# -from enum import IntEnum - -class ShutterState(IntEnum): - shutterOpen = 0, - shutterClosed = 1, - shutterOpening = 2, - shutterClosing = 3, - shutterError = 4 diff --git a/templates/enum/telescope_enum.py b/templates/enum/telescope_enum.py deleted file mode 100644 index 32c91dc..0000000 --- a/templates/enum/telescope_enum.py +++ /dev/null @@ -1,39 +0,0 @@ -# -------------- -# SYMBOLIC ENUMS -# -------------- -# -from enum import IntEnum - -class AlignmentModes(IntEnum): - algAltAz = 0, - algPolar = 1, - algGermanPolar = 2 - -class DriveRates(IntEnum): - driveSidereal = 0, - driveLunar = 1, - driveSolar = 2, - driveKing = 3 - -class EquatorialCoordinateType(IntEnum): - equOther = 0, - equTopocentric = 1, - equJ2000 = 2, - equJ2050 = 3, - equB1950 = 4 - -class GuideDirections(IntEnum): # Shared by Camera - guideNorth = 0, - guideSouth = 1, - guideEast = 2, - guideWest = 3 - -class PierSide(IntEnum): - pierEast = 0, - pierWest = 1, - pierUnknown = -1 - -class TelescopeAxes(IntEnum): - axisPrimary = 0, - axisSecondary = 1, - axisTertiary = 2 diff --git a/templates/filterwheel.py b/templates/filterwheel.py deleted file mode 100644 index a9e295c..0000000 --- a/templates/filterwheel.py +++ /dev/null @@ -1,259 +0,0 @@ - -# -*- coding: utf-8 -*- -# -# ----------------------------------------------------------------------------- -# filterwheel.py - Alpaca API responders for Filterwheel -# -# Author: Your R. Name (abc) -# -# ----------------------------------------------------------------------------- -# Edit History: -# Generated by Python Interface Generator for AlpycaDevice -# -# ??-???-???? abc Initial edit - -from falcon import Request, Response, HTTPBadRequest, before -from logging import Logger -from shr import PropertyResponse, MethodResponse, PreProcessRequest, \ - StateValue, get_request_field, to_bool -from exceptions import * # Nothing but exception classes - -logger: Logger = None - -# ---------------------- -# MULTI-INSTANCE SUPPORT -# ---------------------- -# If this is > 0 then it means that multiple devices of this type are supported. -# Each responder on_get() and on_put() is called with a devnum parameter to indicate -# which instance of the device (0-based) is being called by the client. Leave this -# set to 0 for the simple case of controlling only one instance of this device type. -# -maxdev = 0 # Single instance - -# ----------- -# DEVICE INFO -# ----------- -# Static metadata not subject to configuration changes -## EDIT FOR YOUR DEVICE ## -class FilterwheelMetadata: - """ Metadata describing the Filterwheel Device. Edit for your device""" - Name = 'Sample Filterwheel' - Version = '##DRIVER VERSION AS STRING##' - Description = 'My ASCOM Filterwheel' - DeviceType = 'Filterwheel' - DeviceID = '##GENERATE A NEW GUID AND PASTE HERE##' # https://guidgenerator.com/online-guid-generator.aspx - Info = 'Alpaca Sample Device\nImplements IFilterwheel\nASCOM Initiative' - MaxDeviceNumber = maxdev - InterfaceVersion = ##YOUR DEVICE INTERFACE VERSION## # IFilterwheelVxxx - - -# -------------------- -# RESOURCE CONTROLLERS -# -------------------- - -@before(PreProcessRequest(maxdev)) -class action: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandblind: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandbool: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandstring: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class connect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------ - ### CONNECT THE DEVICE ### - # ------------------------ - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Filterwheel.Connect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connected: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------------- - is_conn = ### READ CONN STATE ### - # ------------------------------------- - resp.text = PropertyResponse(is_conn, req).json - except Exception as ex: - resp.text = MethodResponse(req, DriverException(0x500, 'Filterwheel.Connected failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - conn_str = get_request_field('Connected', req) - conn = to_bool(conn_str) # Raises 400 Bad Request if str to bool fails - - try: - # -------------------------------------- - ### CONNECT OR DISCONNECT THE DEVICE ### - # -------------------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, # Put is actually like a method :-( - DriverException(0x500, 'Filterwheel.Connected failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connecting: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------ - val = ## GET CONNECTING STATE ## - # ------------------------------ - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Filterwheel.Connecting failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class description: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(FilterwheelMetadata.Description, req).json - -@before(PreProcessRequest(maxdev)) -class devicestate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # ---------------------- - val = [] - # val.append(StateValue('## NAME ##', ## GET VAL ##)) - # Repeat for each of the operational states per the device spec - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'filterwheel.Devicestate failed', ex)).json - - -class disconnect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # --------------------------- - ### DISCONNECT THE DEVICE ### - # --------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Filterwheel.Disconnect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class driverinfo: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(FilterwheelMetadata.Info, req).json - -@before(PreProcessRequest(maxdev)) -class interfaceversion: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(FilterwheelMetadata.InterfaceVersion, req).json - -@before(PreProcessRequest(maxdev)) -class driverversion(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(FilterwheelMetadata.Version, req).json - -@before(PreProcessRequest(maxdev)) -class name(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(FilterwheelMetadata.Name, req).json - -@before(PreProcessRequest(maxdev)) -class supportedactions: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse([], req).json # Not PropertyNotImplemented - -@before(PreProcessRequest(maxdev)) -class focusoffsets: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Filterwheel.Focusoffsets failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class names: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Filterwheel.Names failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class position: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Filterwheel.Position failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - positionstr = get_request_field('Position', req) # Raises 400 bad request if missing - try: - position = int(positionstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Position {positionstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Filterwheel.Position failed', ex)).json - diff --git a/templates/focuser.py b/templates/focuser.py deleted file mode 100644 index 2a89a49..0000000 --- a/templates/focuser.py +++ /dev/null @@ -1,411 +0,0 @@ - -# -*- coding: utf-8 -*- -# -# ----------------------------------------------------------------------------- -# focuser.py - Alpaca API responders for Focuser -# -# Author: Your R. Name (abc) -# -# ----------------------------------------------------------------------------- -# Edit History: -# Generated by Python Interface Generator for AlpycaDevice -# -# ??-???-???? abc Initial edit - -from falcon import Request, Response, HTTPBadRequest, before -from logging import Logger -from shr import PropertyResponse, MethodResponse, PreProcessRequest, \ - StateValue, get_request_field, to_bool -from exceptions import * # Nothing but exception classes - -logger: Logger = None - -# ---------------------- -# MULTI-INSTANCE SUPPORT -# ---------------------- -# If this is > 0 then it means that multiple devices of this type are supported. -# Each responder on_get() and on_put() is called with a devnum parameter to indicate -# which instance of the device (0-based) is being called by the client. Leave this -# set to 0 for the simple case of controlling only one instance of this device type. -# -maxdev = 0 # Single instance - -# ----------- -# DEVICE INFO -# ----------- -# Static metadata not subject to configuration changes -## EDIT FOR YOUR DEVICE ## -class FocuserMetadata: - """ Metadata describing the Focuser Device. Edit for your device""" - Name = 'Sample Focuser' - Version = '##DRIVER VERSION AS STRING##' - Description = 'My ASCOM Focuser' - DeviceType = 'Focuser' - DeviceID = '##GENERATE A NEW GUID AND PASTE HERE##' # https://guidgenerator.com/online-guid-generator.aspx - Info = 'Alpaca Sample Device\nImplements IFocuser\nASCOM Initiative' - MaxDeviceNumber = maxdev - InterfaceVersion = ##YOUR DEVICE INTERFACE VERSION## # IFocuserVxxx - - -# -------------------- -# RESOURCE CONTROLLERS -# -------------------- - -@before(PreProcessRequest(maxdev)) -class action: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandblind: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandbool: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandstring: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class connect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------ - ### CONNECT THE DEVICE ### - # ------------------------ - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Focuser.Connect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connected: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------------- - is_conn = ### READ CONN STATE ### - # ------------------------------------- - resp.text = PropertyResponse(is_conn, req).json - except Exception as ex: - resp.text = MethodResponse(req, DriverException(0x500, 'Focuser.Connected failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - conn_str = get_request_field('Connected', req) - conn = to_bool(conn_str) # Raises 400 Bad Request if str to bool fails - - try: - # -------------------------------------- - ### CONNECT OR DISCONNECT THE DEVICE ### - # -------------------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, # Put is actually like a method :-( - DriverException(0x500, 'Focuser.Connected failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connecting: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------ - val = ## GET CONNECTING STATE ## - # ------------------------------ - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Focuser.Connecting failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class description: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(FocuserMetadata.Description, req).json - -@before(PreProcessRequest(maxdev)) -class devicestate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # ---------------------- - val = [] - # val.append(StateValue('## NAME ##', ## GET VAL ##)) - # Repeat for each of the operational states per the device spec - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'focuser.Devicestate failed', ex)).json - - -class disconnect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # --------------------------- - ### DISCONNECT THE DEVICE ### - # --------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Focuser.Disconnect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class driverinfo: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(FocuserMetadata.Info, req).json - -@before(PreProcessRequest(maxdev)) -class interfaceversion: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(FocuserMetadata.InterfaceVersion, req).json - -@before(PreProcessRequest(maxdev)) -class driverversion(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(FocuserMetadata.Version, req).json - -@before(PreProcessRequest(maxdev)) -class name(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(FocuserMetadata.Name, req).json - -@before(PreProcessRequest(maxdev)) -class supportedactions: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse([], req).json # Not PropertyNotImplemented - -@before(PreProcessRequest(maxdev)) -class absolute: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Focuser.Absolute failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class ismoving: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Focuser.Ismoving failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class maxincrement: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Focuser.Maxincrement failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class maxstep: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Focuser.Maxstep failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class position: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Focuser.Position failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class stepsize: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Focuser.Stepsize failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class tempcomp: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Focuser.Tempcomp failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - tempcompstr = get_request_field('TempComp', req) # Raises 400 bad request if missing - try: - tempcomp = to_bool(tempcompstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'TempComp {tempcompstr} not a valid boolean.')).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Focuser.Tempcomp failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class tempcompavailable: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Focuser.Tempcompavailable failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class temperature: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Focuser.Temperature failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class halt: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Focuser.Halt failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class move: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - positionstr = get_request_field('Position', req) # Raises 400 bad request if missing - try: - position = int(positionstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Position {positionstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Focuser.Move failed', ex)).json - diff --git a/templates/rotator.py b/templates/rotator.py deleted file mode 100644 index 8a8daea..0000000 --- a/templates/rotator.py +++ /dev/null @@ -1,453 +0,0 @@ - -# -*- coding: utf-8 -*- -# -# ----------------------------------------------------------------------------- -# rotator.py - Alpaca API responders for Rotator -# -# Author: Your R. Name (abc) -# -# ----------------------------------------------------------------------------- -# Edit History: -# Generated by Python Interface Generator for AlpycaDevice -# -# ??-???-???? abc Initial edit - -from falcon import Request, Response, HTTPBadRequest, before -from logging import Logger -from shr import PropertyResponse, MethodResponse, PreProcessRequest, \ - StateValue, get_request_field, to_bool -from exceptions import * # Nothing but exception classes - -logger: Logger = None - -# ---------------------- -# MULTI-INSTANCE SUPPORT -# ---------------------- -# If this is > 0 then it means that multiple devices of this type are supported. -# Each responder on_get() and on_put() is called with a devnum parameter to indicate -# which instance of the device (0-based) is being called by the client. Leave this -# set to 0 for the simple case of controlling only one instance of this device type. -# -maxdev = 0 # Single instance - -# ----------- -# DEVICE INFO -# ----------- -# Static metadata not subject to configuration changes -## EDIT FOR YOUR DEVICE ## -class RotatorMetadata: - """ Metadata describing the Rotator Device. Edit for your device""" - Name = 'Sample Rotator' - Version = '##DRIVER VERSION AS STRING##' - Description = 'My ASCOM Rotator' - DeviceType = 'Rotator' - DeviceID = '##GENERATE A NEW GUID AND PASTE HERE##' # https://guidgenerator.com/online-guid-generator.aspx - Info = 'Alpaca Sample Device\nImplements IRotator\nASCOM Initiative' - MaxDeviceNumber = maxdev - InterfaceVersion = ##YOUR DEVICE INTERFACE VERSION## # IRotatorVxxx - - -# -------------------- -# RESOURCE CONTROLLERS -# -------------------- - -@before(PreProcessRequest(maxdev)) -class action: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandblind: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandbool: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandstring: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class connect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------ - ### CONNECT THE DEVICE ### - # ------------------------ - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Rotator.Connect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connected: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------------- - is_conn = ### READ CONN STATE ### - # ------------------------------------- - resp.text = PropertyResponse(is_conn, req).json - except Exception as ex: - resp.text = MethodResponse(req, DriverException(0x500, 'Rotator.Connected failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - conn_str = get_request_field('Connected', req) - conn = to_bool(conn_str) # Raises 400 Bad Request if str to bool fails - - try: - # -------------------------------------- - ### CONNECT OR DISCONNECT THE DEVICE ### - # -------------------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, # Put is actually like a method :-( - DriverException(0x500, 'Rotator.Connected failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connecting: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------ - val = ## GET CONNECTING STATE ## - # ------------------------------ - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Rotator.Connecting failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class description: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(RotatorMetadata.Description, req).json - -@before(PreProcessRequest(maxdev)) -class devicestate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # ---------------------- - val = [] - # val.append(StateValue('## NAME ##', ## GET VAL ##)) - # Repeat for each of the operational states per the device spec - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'rotator.Devicestate failed', ex)).json - - -class disconnect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # --------------------------- - ### DISCONNECT THE DEVICE ### - # --------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Rotator.Disconnect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class driverinfo: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(RotatorMetadata.Info, req).json - -@before(PreProcessRequest(maxdev)) -class interfaceversion: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(RotatorMetadata.InterfaceVersion, req).json - -@before(PreProcessRequest(maxdev)) -class driverversion(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(RotatorMetadata.Version, req).json - -@before(PreProcessRequest(maxdev)) -class name(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(RotatorMetadata.Name, req).json - -@before(PreProcessRequest(maxdev)) -class supportedactions: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse([], req).json # Not PropertyNotImplemented - -@before(PreProcessRequest(maxdev)) -class canreverse: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Rotator.Canreverse failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class ismoving: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Rotator.Ismoving failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class mechanicalposition: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Rotator.Mechanicalposition failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class position: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Rotator.Position failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class reverse: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Rotator.Reverse failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - reversestr = get_request_field('Reverse', req) # Raises 400 bad request if missing - try: - reverse = to_bool(reversestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Reverse {reversestr} not a valid boolean.')).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Rotator.Reverse failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class stepsize: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Rotator.Stepsize failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class targetposition: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Rotator.Targetposition failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class halt: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Rotator.Halt failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class move: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - positionstr = get_request_field('Position', req) # Raises 400 bad request if missing - try: - position = float(positionstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Position {positionstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Rotator.Move failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class moveabsolute: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - positionstr = get_request_field('Position', req) # Raises 400 bad request if missing - try: - position = float(positionstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Position {positionstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Rotator.Moveabsolute failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class movemechanical: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - positionstr = get_request_field('Position', req) # Raises 400 bad request if missing - try: - position = float(positionstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Position {positionstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Rotator.Movemechanical failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class sync: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - positionstr = get_request_field('Position', req) # Raises 400 bad request if missing - try: - position = float(positionstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Position {positionstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Rotator.Sync failed', ex)).json - diff --git a/templates/safetymonitor.py b/templates/safetymonitor.py deleted file mode 100644 index 188d85b..0000000 --- a/templates/safetymonitor.py +++ /dev/null @@ -1,200 +0,0 @@ - -# -*- coding: utf-8 -*- -# -# ----------------------------------------------------------------------------- -# safetymonitor.py - Alpaca API responders for Safetymonitor -# -# Author: Your R. Name (abc) -# -# ----------------------------------------------------------------------------- -# Edit History: -# Generated by Python Interface Generator for AlpycaDevice -# -# ??-???-???? abc Initial edit - -from falcon import Request, Response, HTTPBadRequest, before -from logging import Logger -from shr import PropertyResponse, MethodResponse, PreProcessRequest, \ - StateValue, get_request_field, to_bool -from exceptions import * # Nothing but exception classes - -logger: Logger = None - -# ---------------------- -# MULTI-INSTANCE SUPPORT -# ---------------------- -# If this is > 0 then it means that multiple devices of this type are supported. -# Each responder on_get() and on_put() is called with a devnum parameter to indicate -# which instance of the device (0-based) is being called by the client. Leave this -# set to 0 for the simple case of controlling only one instance of this device type. -# -maxdev = 0 # Single instance - -# ----------- -# DEVICE INFO -# ----------- -# Static metadata not subject to configuration changes -## EDIT FOR YOUR DEVICE ## -class SafetymonitorMetadata: - """ Metadata describing the Safetymonitor Device. Edit for your device""" - Name = 'Sample Safetymonitor' - Version = '##DRIVER VERSION AS STRING##' - Description = 'My ASCOM Safetymonitor' - DeviceType = 'Safetymonitor' - DeviceID = '##GENERATE A NEW GUID AND PASTE HERE##' # https://guidgenerator.com/online-guid-generator.aspx - Info = 'Alpaca Sample Device\nImplements ISafetymonitor\nASCOM Initiative' - MaxDeviceNumber = maxdev - InterfaceVersion = ##YOUR DEVICE INTERFACE VERSION## # ISafetymonitorVxxx - - -# -------------------- -# RESOURCE CONTROLLERS -# -------------------- - -@before(PreProcessRequest(maxdev)) -class action: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandblind: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandbool: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandstring: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class connect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------ - ### CONNECT THE DEVICE ### - # ------------------------ - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Safetymonitor.Connect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connected: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------------- - is_conn = ### READ CONN STATE ### - # ------------------------------------- - resp.text = PropertyResponse(is_conn, req).json - except Exception as ex: - resp.text = MethodResponse(req, DriverException(0x500, 'Safetymonitor.Connected failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - conn_str = get_request_field('Connected', req) - conn = to_bool(conn_str) # Raises 400 Bad Request if str to bool fails - - try: - # -------------------------------------- - ### CONNECT OR DISCONNECT THE DEVICE ### - # -------------------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, # Put is actually like a method :-( - DriverException(0x500, 'Safetymonitor.Connected failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connecting: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------ - val = ## GET CONNECTING STATE ## - # ------------------------------ - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Safetymonitor.Connecting failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class description: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(SafetymonitorMetadata.Description, req).json - -@before(PreProcessRequest(maxdev)) -class devicestate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # ---------------------- - val = [] - # val.append(StateValue('## NAME ##', ## GET VAL ##)) - # Repeat for each of the operational states per the device spec - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'safetymonitor.Devicestate failed', ex)).json - - -class disconnect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # --------------------------- - ### DISCONNECT THE DEVICE ### - # --------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Safetymonitor.Disconnect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class driverinfo: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(SafetymonitorMetadata.Info, req).json - -@before(PreProcessRequest(maxdev)) -class interfaceversion: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(SafetymonitorMetadata.InterfaceVersion, req).json - -@before(PreProcessRequest(maxdev)) -class driverversion(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(SafetymonitorMetadata.Version, req).json - -@before(PreProcessRequest(maxdev)) -class name(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(SafetymonitorMetadata.Name, req).json - -@before(PreProcessRequest(maxdev)) -class supportedactions: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse([], req).json # Not PropertyNotImplemented - -@before(PreProcessRequest(maxdev)) -class issafe: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Safetymonitor.Issafe failed', ex)).json - diff --git a/templates/switch.py b/templates/switch.py deleted file mode 100644 index c468eb9..0000000 --- a/templates/switch.py +++ /dev/null @@ -1,650 +0,0 @@ - -# -*- coding: utf-8 -*- -# -# ----------------------------------------------------------------------------- -# switch.py - Alpaca API responders for Switch -# -# Author: Your R. Name (abc) -# -# ----------------------------------------------------------------------------- -# Edit History: -# Generated by Python Interface Generator for AlpycaDevice -# -# ??-???-???? abc Initial edit - -from falcon import Request, Response, HTTPBadRequest, before -from logging import Logger -from shr import PropertyResponse, MethodResponse, PreProcessRequest, \ - StateValue, get_request_field, to_bool -from exceptions import * # Nothing but exception classes - -logger: Logger = None - -# ---------------------- -# MULTI-INSTANCE SUPPORT -# ---------------------- -# If this is > 0 then it means that multiple devices of this type are supported. -# Each responder on_get() and on_put() is called with a devnum parameter to indicate -# which instance of the device (0-based) is being called by the client. Leave this -# set to 0 for the simple case of controlling only one instance of this device type. -# -maxdev = 0 # Single instance - -# ----------- -# DEVICE INFO -# ----------- -# Static metadata not subject to configuration changes -## EDIT FOR YOUR DEVICE ## -class SwitchMetadata: - """ Metadata describing the Switch Device. Edit for your device""" - Name = 'Sample Switch' - Version = '##DRIVER VERSION AS STRING##' - Description = 'My ASCOM Switch' - DeviceType = 'Switch' - DeviceID = '##GENERATE A NEW GUID AND PASTE HERE##' # https://guidgenerator.com/online-guid-generator.aspx - Info = 'Alpaca Sample Device\nImplements ISwitch\nASCOM Initiative' - MaxDeviceNumber = maxdev - InterfaceVersion = ##YOUR DEVICE INTERFACE VERSION## # ISwitchVxxx - - -# -------------------- -# RESOURCE CONTROLLERS -# -------------------- - -@before(PreProcessRequest(maxdev)) -class action: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandblind: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandbool: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandstring: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class connect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------ - ### CONNECT THE DEVICE ### - # ------------------------ - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Switch.Connect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connected: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------------- - is_conn = ### READ CONN STATE ### - # ------------------------------------- - resp.text = PropertyResponse(is_conn, req).json - except Exception as ex: - resp.text = MethodResponse(req, DriverException(0x500, 'Switch.Connected failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - conn_str = get_request_field('Connected', req) - conn = to_bool(conn_str) # Raises 400 Bad Request if str to bool fails - - try: - # -------------------------------------- - ### CONNECT OR DISCONNECT THE DEVICE ### - # -------------------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, # Put is actually like a method :-( - DriverException(0x500, 'Switch.Connected failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connecting: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------ - val = ## GET CONNECTING STATE ## - # ------------------------------ - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Switch.Connecting failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class description: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(SwitchMetadata.Description, req).json - -@before(PreProcessRequest(maxdev)) -class devicestate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # ---------------------- - val = [] - # val.append(StateValue('## NAME ##', ## GET VAL ##)) - # Repeat for each of the operational states per the device spec - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'switch.Devicestate failed', ex)).json - - -class disconnect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # --------------------------- - ### DISCONNECT THE DEVICE ### - # --------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Switch.Disconnect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class driverinfo: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(SwitchMetadata.Info, req).json - -@before(PreProcessRequest(maxdev)) -class interfaceversion: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(SwitchMetadata.InterfaceVersion, req).json - -@before(PreProcessRequest(maxdev)) -class driverversion(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(SwitchMetadata.Version, req).json - -@before(PreProcessRequest(maxdev)) -class name(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(SwitchMetadata.Name, req).json - -@before(PreProcessRequest(maxdev)) -class supportedactions: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse([], req).json # Not PropertyNotImplemented - -@before(PreProcessRequest(maxdev)) -class maxswitch: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Switch.Maxswitch failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canwrite: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - idstr = get_request_field('Id', req) # Raises 400 bad request if missing - try: - id = int(idstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Id {idstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Switch.Canwrite failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class getswitch: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - idstr = get_request_field('Id', req) # Raises 400 bad request if missing - try: - id = int(idstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Id {idstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Switch.Getswitch failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class getswitchdescription: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - idstr = get_request_field('Id', req) # Raises 400 bad request if missing - try: - id = int(idstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Id {idstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Switch.Getswitchdescription failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class getswitchname: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - idstr = get_request_field('Id', req) # Raises 400 bad request if missing - try: - id = int(idstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Id {idstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Switch.Getswitchname failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class getswitchvalue: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - idstr = get_request_field('Id', req) # Raises 400 bad request if missing - try: - id = int(idstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Id {idstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Switch.Getswitchvalue failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class minswitchvalue: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - idstr = get_request_field('Id', req) # Raises 400 bad request if missing - try: - id = int(idstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Id {idstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Switch.Minswitchvalue failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class maxswitchvalue: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - idstr = get_request_field('Id', req) # Raises 400 bad request if missing - try: - id = int(idstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Id {idstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Switch.Maxswitchvalue failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class switchstep: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - idstr = get_request_field('Id', req) # Raises 400 bad request if missing - try: - id = int(idstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Id {idstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Switch.Switchstep failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class setswitch: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - idstr = get_request_field('Id', req) # Raises 400 bad request if missing - try: - id = int(idstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Id {idstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - statestr = get_request_field('State', req) # Raises 400 bad request if missing - try: - state = to_bool(statestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'State {statestr} not a valid boolean.')).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Switch.Setswitch failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class setswitchname: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - idstr = get_request_field('Id', req) # Raises 400 bad request if missing - try: - id = int(idstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Id {idstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - name = get_request_field('Name', req) # Raises 400 bad request if missing - ### INTEPRET AS NEEDED OR FAIL ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Switch.Setswitchname failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class setswitchvalue: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - idstr = get_request_field('Id', req) # Raises 400 bad request if missing - try: - id = int(idstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Id {idstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - valuestr = get_request_field('Value', req) # Raises 400 bad request if missing - try: - value = float(valuestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Value {valuestr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Switch.Setswitchvalue failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canasync: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - idstr = get_request_field('Id', req) # Raises 400 bad request if missing - try: - id = int(idstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Id {idstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Switch.Canasync failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class statechangecomplete: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - idstr = get_request_field('Id', req) # Raises 400 bad request if missing - try: - id = int(idstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Id {idstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Switch.Statechangecomplete failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cancelasync: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - idstr = get_request_field('Id', req) # Raises 400 bad request if missing - try: - id = int(idstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Id {idstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Switch.Cancelasync failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class setasync: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - idstr = get_request_field('Id', req) # Raises 400 bad request if missing - try: - id = int(idstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Id {idstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - statestr = get_request_field('State', req) # Raises 400 bad request if missing - try: - state = to_bool(statestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'State {statestr} not a valid boolean.')).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Switch.Setasync failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class setasyncvalue: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - idstr = get_request_field('Id', req) # Raises 400 bad request if missing - try: - id = int(idstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Id {idstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - valuestr = get_request_field('Value', req) # Raises 400 bad request if missing - try: - value = float(valuestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Value {valuestr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Switch.Setasyncvalue failed', ex)).json - diff --git a/templates/telescope.py b/templates/telescope.py deleted file mode 100644 index 07bde51..0000000 --- a/templates/telescope.py +++ /dev/null @@ -1,1910 +0,0 @@ - -# -*- coding: utf-8 -*- -# -# ----------------------------------------------------------------------------- -# telescope.py - Alpaca API responders for Telescope -# -# Author: Your R. Name (abc) -# -# ----------------------------------------------------------------------------- -# Edit History: -# Generated by Python Interface Generator for AlpycaDevice -# -# ??-???-???? abc Initial edit - -from falcon import Request, Response, HTTPBadRequest, before -from logging import Logger -from shr import PropertyResponse, MethodResponse, PreProcessRequest, \ - StateValue, get_request_field, to_bool -from exceptions import * # Nothing but exception classes - -logger: Logger = None - -# ---------------------- -# MULTI-INSTANCE SUPPORT -# ---------------------- -# If this is > 0 then it means that multiple devices of this type are supported. -# Each responder on_get() and on_put() is called with a devnum parameter to indicate -# which instance of the device (0-based) is being called by the client. Leave this -# set to 0 for the simple case of controlling only one instance of this device type. -# -maxdev = 0 # Single instance - -# ----------- -# DEVICE INFO -# ----------- -# Static metadata not subject to configuration changes -## EDIT FOR YOUR DEVICE ## -class TelescopeMetadata: - """ Metadata describing the Telescope Device. Edit for your device""" - Name = 'Sample Telescope' - Version = '##DRIVER VERSION AS STRING##' - Description = 'My ASCOM Telescope' - DeviceType = 'Telescope' - DeviceID = '##GENERATE A NEW GUID AND PASTE HERE##' # https://guidgenerator.com/online-guid-generator.aspx - Info = 'Alpaca Sample Device\nImplements ITelescope\nASCOM Initiative' - MaxDeviceNumber = maxdev - InterfaceVersion = ##YOUR DEVICE INTERFACE VERSION## # ITelescopeVxxx - -# -------------- -# SYMBOLIC ENUMS -# -------------- -# -from enum import IntEnum - -class AlignmentModes(IntEnum): - algAltAz = 0, - algPolar = 1, - algGermanPolar = 2 - -class DriveRates(IntEnum): - driveSidereal = 0, - driveLunar = 1, - driveSolar = 2, - driveKing = 3 - -class EquatorialCoordinateType(IntEnum): - equOther = 0, - equTopocentric = 1, - equJ2000 = 2, - equJ2050 = 3, - equB1950 = 4 - -class GuideDirections(IntEnum): # Shared by Camera - guideNorth = 0, - guideSouth = 1, - guideEast = 2, - guideWest = 3 - -class PierSide(IntEnum): - pierEast = 0, - pierWest = 1, - pierUnknown = -1 - -class TelescopeAxes(IntEnum): - axisPrimary = 0, - axisSecondary = 1, - axisTertiary = 2 - -# -------------------- -# RESOURCE CONTROLLERS -# -------------------- - -@before(PreProcessRequest(maxdev)) -class action: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandblind: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandbool: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class commandstring: - def on_put(self, req: Request, resp: Response, devnum: int): - resp.text = MethodResponse(req, NotImplementedException()).json - -@before(PreProcessRequest(maxdev)) -class connect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------ - ### CONNECT THE DEVICE ### - # ------------------------ - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Connect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connected: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------------- - is_conn = ### READ CONN STATE ### - # ------------------------------------- - resp.text = PropertyResponse(is_conn, req).json - except Exception as ex: - resp.text = MethodResponse(req, DriverException(0x500, 'Telescope.Connected failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - conn_str = get_request_field('Connected', req) - conn = to_bool(conn_str) # Raises 400 Bad Request if str to bool fails - - try: - # -------------------------------------- - ### CONNECT OR DISCONNECT THE DEVICE ### - # -------------------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, # Put is actually like a method :-( - DriverException(0x500, 'Telescope.Connected failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class connecting: - def on_get(self, req: Request, resp: Response, devnum: int): - try: - # ------------------------------ - val = ## GET CONNECTING STATE ## - # ------------------------------ - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Connecting failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class description: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(TelescopeMetadata.Description, req).json - -@before(PreProcessRequest(maxdev)) -class devicestate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - try: - # ---------------------- - val = [] - # val.append(StateValue('## NAME ##', ## GET VAL ##)) - # Repeat for each of the operational states per the device spec - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'telescope.Devicestate failed', ex)).json - - -class disconnect: - def on_put(self, req: Request, resp: Response, devnum: int): - try: - # --------------------------- - ### DISCONNECT THE DEVICE ### - # --------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Disconnect failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class driverinfo: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(TelescopeMetadata.Info, req).json - -@before(PreProcessRequest(maxdev)) -class interfaceversion: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(TelescopeMetadata.InterfaceVersion, req).json - -@before(PreProcessRequest(maxdev)) -class driverversion(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(TelescopeMetadata.Version, req).json - -@before(PreProcessRequest(maxdev)) -class name(): - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse(TelescopeMetadata.Name, req).json - -@before(PreProcessRequest(maxdev)) -class supportedactions: - def on_get(self, req: Request, resp: Response, devnum: int): - resp.text = PropertyResponse([], req).json # Not PropertyNotImplemented - -@before(PreProcessRequest(maxdev)) -class abortslew: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Abortslew failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class alignmentmode: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Alignmentmode failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class altitude: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Altitude failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class aperturearea: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Aperturearea failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class aperturediameter: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Aperturediameter failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class athome: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Athome failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class atpark: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Atpark failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class axisrates: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - axisstr = get_request_field('Axis', req) # Raises 400 bad request if missing - try: - axis = int(axisstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Axis {axisstr} not a valid integer.')).json - return - if not axis in [0, 1, 2]: - resp.text = MethodResponse(req, - InvalidValueException(f'Axis {axis} not a valid enum value.')).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Axisrates failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class azimuth: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Azimuth failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canfindhome: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Canfindhome failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canmoveaxis: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - axisstr = get_request_field('Axis', req) # Raises 400 bad request if missing - try: - axis = int(axisstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Axis {axisstr} not a valid integer.')).json - return - if not axis in [0, 1, 2]: - resp.text = MethodResponse(req, - InvalidValueException(f'Axis {axis} not a valid enum value.')).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Canmoveaxis failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canpark: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Canpark failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canpulseguide: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Canpulseguide failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cansetdeclinationrate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Cansetdeclinationrate failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cansetguiderates: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Cansetguiderates failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cansetpark: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Cansetpark failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cansetpierside: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Cansetpierside failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cansetrightascensionrate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Cansetrightascensionrate failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cansettracking: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Cansettracking failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canslew: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Canslew failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canslewaltaz: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Canslewaltaz failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canslewaltazasync: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Canslewaltazasync failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canslewasync: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Canslewasync failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cansync: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Cansync failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class cansyncaltaz: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Cansyncaltaz failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class canunpark: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Canunpark failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class declination: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Declination failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class declinationrate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Declinationrate failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - declinationratestr = get_request_field('DeclinationRate', req) # Raises 400 bad request if missing - try: - declinationrate = float(declinationratestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'DeclinationRate {declinationratestr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Declinationrate failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class destinationsideofpier: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - rightascensionstr = get_request_field('RightAscension', req) # Raises 400 bad request if missing - try: - rightascension = float(rightascensionstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'RightAscension {rightascensionstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - declinationstr = get_request_field('Declination', req) # Raises 400 bad request if missing - try: - declination = float(declinationstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Declination {declinationstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Destinationsideofpier failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class doesrefraction: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Doesrefraction failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - doesrefractionstr = get_request_field('DoesRefraction', req) # Raises 400 bad request if missing - try: - doesrefraction = to_bool(doesrefractionstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'DoesRefraction {doesrefractionstr} not a valid boolean.')).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Doesrefraction failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class equatorialsystem: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Equatorialsystem failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class findhome: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Findhome failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class focallength: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Focallength failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class guideratedeclination: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Guideratedeclination failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - guideratedeclinationstr = get_request_field('GuideRateDeclination', req) # Raises 400 bad request if missing - try: - guideratedeclination = float(guideratedeclinationstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'GuideRateDeclination {guideratedeclinationstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Guideratedeclination failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class guideraterightascension: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Guideraterightascension failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - guideraterightascensionstr = get_request_field('GuideRateRightAscension', req) # Raises 400 bad request if missing - try: - guideraterightascension = float(guideraterightascensionstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'GuideRateRightAscension {guideraterightascensionstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Guideraterightascension failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class ispulseguiding: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Ispulseguiding failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class moveaxis: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - axisstr = get_request_field('Axis', req) # Raises 400 bad request if missing - try: - axis = int(axisstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Axis {axisstr} not a valid integer.')).json - return - if not axis in [0, 1, 2]: - resp.text = MethodResponse(req, - InvalidValueException(f'Axis {axis} not a valid enum value.')).json - return - - ratestr = get_request_field('Rate', req) # Raises 400 bad request if missing - try: - rate = float(ratestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Rate {ratestr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Moveaxis failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class park: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Park failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class pulseguide: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - directionstr = get_request_field('Direction', req) # Raises 400 bad request if missing - try: - direction = int(directionstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Direction {directionstr} not a valid integer.')).json - return - if not direction in [0, 1, 2, 3]: - resp.text = MethodResponse(req, - InvalidValueException(f'Direction {direction} not a valid enum value.')).json - return - - durationstr = get_request_field('Duration', req) # Raises 400 bad request if missing - try: - duration = int(durationstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Duration {durationstr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Pulseguide failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class rightascension: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Rightascension failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class rightascensionrate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Rightascensionrate failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - rightascensionratestr = get_request_field('RightAscensionRate', req) # Raises 400 bad request if missing - try: - rightascensionrate = float(rightascensionratestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'RightAscensionRate {rightascensionratestr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Rightascensionrate failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class setpark: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Setpark failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class sideofpier: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Sideofpier failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - sideofpierstr = get_request_field('SideOfPier', req) # Raises 400 bad request if missing - try: - sideofpier = int(sideofpierstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'SideOfPier {sideofpierstr} not a valid integer.')).json - return - if not sideofpier in [0, 1, -1]: - resp.text = MethodResponse(req, - InvalidValueException(f'SideOfPier {sideofpier} not a valid enum value.')).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Sideofpier failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class siderealtime: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Siderealtime failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class siteelevation: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Siteelevation failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - siteelevationstr = get_request_field('SiteElevation', req) # Raises 400 bad request if missing - try: - siteelevation = float(siteelevationstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'SiteElevation {siteelevationstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Siteelevation failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class sitelatitude: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Sitelatitude failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - sitelatitudestr = get_request_field('SiteLatitude', req) # Raises 400 bad request if missing - try: - sitelatitude = float(sitelatitudestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'SiteLatitude {sitelatitudestr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Sitelatitude failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class sitelongitude: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Sitelongitude failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - sitelongitudestr = get_request_field('SiteLongitude', req) # Raises 400 bad request if missing - try: - sitelongitude = float(sitelongitudestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'SiteLongitude {sitelongitudestr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Sitelongitude failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class slewing: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Slewing failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class slewsettletime: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Slewsettletime failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - slewsettletimestr = get_request_field('SlewSettleTime', req) # Raises 400 bad request if missing - try: - slewsettletime = int(slewsettletimestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'SlewSettleTime {slewsettletimestr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Slewsettletime failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class slewtoaltaz: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - azimuthstr = get_request_field('Azimuth', req) # Raises 400 bad request if missing - try: - azimuth = float(azimuthstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Azimuth {azimuthstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - altitudestr = get_request_field('Altitude', req) # Raises 400 bad request if missing - try: - altitude = float(altitudestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Altitude {altitudestr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Slewtoaltaz failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class slewtoaltazasync: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - azimuthstr = get_request_field('Azimuth', req) # Raises 400 bad request if missing - try: - azimuth = float(azimuthstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Azimuth {azimuthstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - altitudestr = get_request_field('Altitude', req) # Raises 400 bad request if missing - try: - altitude = float(altitudestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Altitude {altitudestr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Slewtoaltazasync failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class slewtocoordinates: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - rightascensionstr = get_request_field('RightAscension', req) # Raises 400 bad request if missing - try: - rightascension = float(rightascensionstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'RightAscension {rightascensionstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - declinationstr = get_request_field('Declination', req) # Raises 400 bad request if missing - try: - declination = float(declinationstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Declination {declinationstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Slewtocoordinates failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class slewtocoordinatesasync: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - rightascensionstr = get_request_field('RightAscension', req) # Raises 400 bad request if missing - try: - rightascension = float(rightascensionstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'RightAscension {rightascensionstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - declinationstr = get_request_field('Declination', req) # Raises 400 bad request if missing - try: - declination = float(declinationstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Declination {declinationstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Slewtocoordinatesasync failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class slewtotarget: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Slewtotarget failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class slewtotargetasync: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Slewtotargetasync failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class synctoaltaz: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - azimuthstr = get_request_field('Azimuth', req) # Raises 400 bad request if missing - try: - azimuth = float(azimuthstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Azimuth {azimuthstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - altitudestr = get_request_field('Altitude', req) # Raises 400 bad request if missing - try: - altitude = float(altitudestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Altitude {altitudestr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Synctoaltaz failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class synctocoordinates: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - rightascensionstr = get_request_field('RightAscension', req) # Raises 400 bad request if missing - try: - rightascension = float(rightascensionstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'RightAscension {rightascensionstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - declinationstr = get_request_field('Declination', req) # Raises 400 bad request if missing - try: - declination = float(declinationstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Declination {declinationstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Synctocoordinates failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class synctotarget: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Synctotarget failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class targetdeclination: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Targetdeclination failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - targetdeclinationstr = get_request_field('TargetDeclination', req) # Raises 400 bad request if missing - try: - targetdeclination = float(targetdeclinationstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'TargetDeclination {targetdeclinationstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Targetdeclination failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class targetrightascension: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Targetrightascension failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - targetrightascensionstr = get_request_field('TargetRightAscension', req) # Raises 400 bad request if missing - try: - targetrightascension = float(targetrightascensionstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'TargetRightAscension {targetrightascensionstr} not a valid number.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Targetrightascension failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class tracking: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Tracking failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - trackingstr = get_request_field('Tracking', req) # Raises 400 bad request if missing - try: - tracking = to_bool(trackingstr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'Tracking {trackingstr} not a valid boolean.')).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Tracking failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class trackingrate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Trackingrate failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - trackingratestr = get_request_field('TrackingRate', req) # Raises 400 bad request if missing - try: - trackingrate = int(trackingratestr) - except: - resp.text = MethodResponse(req, - InvalidValueException(f'TrackingRate {trackingratestr} not a valid integer.')).json - return - ### RANGE CHECK AS NEEDED ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Trackingrate failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class trackingrates: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Trackingrates failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class utcdate: - - def on_get(self, req: Request, resp: Response, devnum: int): - if not ##IS DEV CONNECTED##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ---------------------- - val = ## GET PROPERTY ## - # ---------------------- - resp.text = PropertyResponse(val, req).json - except Exception as ex: - resp.text = PropertyResponse(None, req, - DriverException(0x500, 'Telescope.Utcdate failed', ex)).json - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - utcdate = get_request_field('UTCDate', req) # Raises 400 bad request if missing - ### INTEPRET AS NEEDED OR FAIL ### # Raise Alpaca InvalidValueException with details! - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Utcdate failed', ex)).json - -@before(PreProcessRequest(maxdev)) -class unpark: - - def on_put(self, req: Request, resp: Response, devnum: int): - if not ## IS DEV CONNECTED ##: - resp.text = PropertyResponse(None, req, - NotConnectedException()).json - return - - try: - # ----------------------------- - ### DEVICE OPERATION(PARAM) ### - # ----------------------------- - resp.text = MethodResponse(req).json - except Exception as ex: - resp.text = MethodResponse(req, - DriverException(0x500, 'Telescope.Unpark failed', ex)).json - diff --git a/thunder-tests/_db-backup/thunderCollection.json b/thunder-tests/_db-backup/thunderCollection.json deleted file mode 100644 index 0637a08..0000000 --- a/thunder-tests/_db-backup/thunderCollection.json +++ /dev/null @@ -1 +0,0 @@ -[] \ No newline at end of file diff --git a/thunder-tests/_db-backup/thunderEnvironment.json b/thunder-tests/_db-backup/thunderEnvironment.json deleted file mode 100644 index 0637a08..0000000 --- a/thunder-tests/_db-backup/thunderEnvironment.json +++ /dev/null @@ -1 +0,0 @@ -[] \ No newline at end of file diff --git a/thunder-tests/_db-backup/thunderclient.json b/thunder-tests/_db-backup/thunderclient.json deleted file mode 100644 index 0637a08..0000000 --- a/thunder-tests/_db-backup/thunderclient.json +++ /dev/null @@ -1 +0,0 @@ -[] \ No newline at end of file diff --git a/thunder-tests/collections/tc_col_alpaca-device-testing-rotator.json b/thunder-tests/collections/tc_col_alpaca-device-testing-rotator.json deleted file mode 100644 index 83e97f7..0000000 --- a/thunder-tests/collections/tc_col_alpaca-device-testing-rotator.json +++ /dev/null @@ -1,404 +0,0 @@ -{ - "_id": "e2eb6a74-b20d-4023-91ab-1cbc5380fc67", - "colName": "Alpaca Device Testing (Rotator)", - "created": "2022-12-17T17:17:32.992Z", - "sortNum": 10000, - "folders": [], - "settings": {}, - "requests": [ - { - "_id": "fbb859e2-619f-43e1-97b5-9700207ecb4f", - "colId": "e2eb6a74-b20d-4023-91ab-1cbc5380fc67", - "containerId": "", - "name": "DriverVersion", - "url": "http://localhost:5555/api/v1/rotator/0/driverversion?ClientID=123&ClientTransactionID=321", - "method": "GET", - "sortNum": 40000, - "created": "2022-12-17T21:05:09.748Z", - "modified": "2024-02-16T00:07:33.738Z", - "headers": [], - "params": [ - { - "name": "ClientID", - "value": "123", - "isPath": false - }, - { - "name": "ClientTransactionID", - "value": "321", - "isPath": false - } - ], - "tests": [] - }, - { - "_id": "b75f4890-9dc4-49c9-a6e6-a2de7a9aaa2b", - "colId": "e2eb6a74-b20d-4023-91ab-1cbc5380fc67", - "containerId": "", - "name": "MoveAbsolute()", - "url": "http://localhost:5555/api/v1/rotator/0/moveabsolute", - "method": "PUT", - "sortNum": 30000, - "created": "2022-12-17T21:11:51.326Z", - "modified": "2024-02-17T22:31:28.172Z", - "headers": [], - "params": [], - "body": { - "type": "formencoded", - "raw": "", - "form": [ - { - "name": "Position", - "value": "123" - }, - { - "name": "ClientID", - "value": "123" - }, - { - "name": "ClientTransactionID", - "value": "321" - } - ] - }, - "tests": [] - }, - { - "_id": "9314312e-1bc4-450b-af3b-e1195a1552a8", - "colId": "e2eb6a74-b20d-4023-91ab-1cbc5380fc67", - "containerId": "", - "name": "Connected", - "url": "http://localhost:5555/api/v1/rotator/0/connected", - "method": "PUT", - "sortNum": 20000, - "created": "2022-12-17T21:38:32.673Z", - "modified": "2023-05-30T22:42:24.346Z", - "headers": [], - "params": [], - "body": { - "type": "formencoded", - "raw": "", - "form": [ - { - "name": "Connected", - "value": "True" - }, - { - "name": "ClientID", - "value": "123" - }, - { - "name": "ClientTransactionID", - "value": "321" - } - ] - }, - "tests": [] - }, - { - "_id": "652dcf10-adbf-402c-b5b6-f05b7707babb", - "colId": "e2eb6a74-b20d-4023-91ab-1cbc5380fc67", - "containerId": "", - "name": "Reverse", - "url": "http://localhost:5555/api/v1/rotator/0/reverse", - "method": "PUT", - "sortNum": 50000, - "created": "2022-12-20T19:01:36.105Z", - "modified": "2023-05-30T23:46:07.115Z", - "headers": [], - "params": [], - "body": { - "type": "formencoded", - "raw": "", - "form": [ - { - "name": "Reverse", - "value": "False" - }, - { - "name": "ClientID", - "value": "123" - }, - { - "name": "ClientTransactionid", - "value": "123456" - } - ] - }, - "tests": [] - }, - { - "_id": "786fae39-5226-4ec4-a346-bc7dc612e60c", - "colId": "e2eb6a74-b20d-4023-91ab-1cbc5380fc67", - "containerId": "", - "name": "Position", - "url": "http://localhost:5555/api/v1/rotator/0/position?ClientID=123&ClientTransactionID=321", - "method": "GET", - "sortNum": 60000, - "created": "2022-12-20T19:05:27.170Z", - "modified": "2024-02-16T00:08:28.364Z", - "headers": [], - "params": [ - { - "name": "ClientID", - "value": "123", - "isPath": false - }, - { - "name": "ClientTransactionID", - "value": "321", - "isPath": false - } - ], - "tests": [] - }, - { - "_id": "cf41060e-8156-4d24-9249-04f76df1420e", - "colId": "e2eb6a74-b20d-4023-91ab-1cbc5380fc67", - "containerId": "", - "name": "MechanicalPosition", - "url": "http://localhost:5555/api/v1/rotator/0/mechanicalposition?ClientID=123&ClientTransactionID=321", - "method": "GET", - "sortNum": 70000, - "created": "2022-12-20T19:10:48.222Z", - "modified": "2024-02-16T00:07:53.772Z", - "headers": [], - "params": [ - { - "name": "ClientID", - "value": "123", - "isPath": false - }, - { - "name": "ClientTransactionID", - "value": "321", - "isPath": false - } - ], - "tests": [] - }, - { - "_id": "b41a7c9e-61d2-4049-ad80-06700e80cfe5", - "colId": "e2eb6a74-b20d-4023-91ab-1cbc5380fc67", - "containerId": "", - "name": "IsMoving", - "url": "http://192.168.0.42:5555/api/v1/rotator/0/ismoving?ClientID=123&ClientTransactionID=321", - "method": "GET", - "sortNum": 80000, - "created": "2022-12-20T20:11:14.649Z", - "modified": "2022-12-20T20:11:14.649Z", - "headers": [], - "params": [ - { - "name": "ClientID", - "value": "123", - "isPath": false - }, - { - "name": "ClientTransactionID", - "value": "321", - "isPath": false - } - ], - "tests": [] - }, - { - "_id": "6bbf43bb-3894-4cc0-9b87-ac37039c3a9d", - "colId": "e2eb6a74-b20d-4023-91ab-1cbc5380fc67", - "containerId": "", - "name": "Halt", - "url": "http://192.168.0.42:5555/api/v1/rotator/0/halt", - "method": "PUT", - "sortNum": 90000, - "created": "2022-12-20T21:06:29.397Z", - "modified": "2022-12-31T03:02:22.625Z", - "headers": [], - "params": [], - "body": { - "type": "formencoded", - "raw": "", - "form": [ - { - "name": "ClientID", - "value": "123" - }, - { - "name": "ClientTransactionID", - "value": "321" - } - ] - }, - "tests": [] - }, - { - "_id": "a3a28831-2c47-421b-9f14-cf0186f652fa", - "colId": "e2eb6a74-b20d-4023-91ab-1cbc5380fc67", - "containerId": "", - "name": "CommandBool", - "url": "http://192.168.0.42:5555/api/v1/rotator/0/commandbool?ClientID=123&ClientTransactionID=321", - "method": "PUT", - "sortNum": 100000, - "created": "2022-12-27T16:53:44.357Z", - "modified": "2022-12-27T17:05:00.669Z", - "headers": [], - "params": [ - { - "name": "ClientID", - "value": "123", - "isPath": false - }, - { - "name": "ClientTransactionID", - "value": "321", - "isPath": false - } - ], - "body": { - "type": "formencoded", - "raw": "", - "form": [ - { - "name": "Command", - "value": "\"foo\"" - }, - { - "name": "Raw", - "value": "false" - } - ] - }, - "tests": [] - }, - { - "_id": "ff233d08-54c4-4d2e-9887-768b0acedf29", - "colId": "e2eb6a74-b20d-4023-91ab-1cbc5380fc67", - "containerId": "", - "name": "Connected", - "url": "http://localhost:5555/api/v1/rotator/0/connected?ClientID=123&ClientTransactionID=321", - "method": "GET", - "sortNum": 25000, - "created": "2023-05-29T22:22:29.996Z", - "modified": "2023-05-29T22:26:58.982Z", - "headers": [], - "params": [ - { - "name": "ClientID", - "value": "123", - "isPath": false - }, - { - "name": "ClientTransactionID", - "value": "321", - "isPath": false - } - ], - "tests": [] - }, - { - "_id": "594a08b9-9418-45b1-b2a3-b71b054fc28a", - "colId": "e2eb6a74-b20d-4023-91ab-1cbc5380fc67", - "containerId": "", - "name": "Connect", - "url": "http://127.0.0.1:5555/api/v1/rotator/0/connect", - "method": "PUT", - "sortNum": 10000, - "created": "2024-02-15T23:13:07.896Z", - "modified": "2024-02-15T23:46:01.429Z", - "headers": [], - "params": [], - "body": { - "type": "formencoded", - "raw": "", - "form": [ - { - "name": "ClientID", - "value": "123" - }, - { - "name": "ClientTransactionID", - "value": "321" - } - ] - }, - "tests": [] - }, - { - "_id": "86ddbe55-5d41-4cfa-a906-68ea20b41e41", - "colId": "e2eb6a74-b20d-4023-91ab-1cbc5380fc67", - "containerId": "", - "name": "Disconnect", - "url": "http://127.0.0.1:5555/api/v1/rotator/0/disconnect", - "method": "PUT", - "sortNum": 15000, - "created": "2024-02-15T23:59:43.278Z", - "modified": "2024-02-16T00:01:17.288Z", - "headers": [], - "params": [], - "body": { - "type": "formencoded", - "raw": "", - "form": [ - { - "name": "ClientID", - "value": "123" - }, - { - "name": "ClientTransactionID", - "value": "321" - } - ] - }, - "tests": [] - }, - { - "_id": "3d49f24c-c9fd-4fac-95fd-1ebdaae9f77e", - "colId": "e2eb6a74-b20d-4023-91ab-1cbc5380fc67", - "containerId": "", - "name": "DeviceState", - "url": "http://localhost:5555/api/v1/rotator/0/devicestate?ClientID=123&ClientTransactionID=321", - "method": "GET", - "sortNum": 12500, - "created": "2024-02-16T00:09:39.574Z", - "modified": "2024-02-16T00:11:18.388Z", - "headers": [], - "params": [ - { - "name": "ClientID", - "value": "123", - "isPath": false - }, - { - "name": "ClientTransactionID", - "value": "321", - "isPath": false - } - ], - "tests": [] - }, - { - "_id": "cc11b7cf-e4a9-40ec-8917-d5ca46209cae", - "colId": "e2eb6a74-b20d-4023-91ab-1cbc5380fc67", - "containerId": "", - "name": "SupportedActions", - "url": "http://localhost:5555/api/v1/rotator/0/supportedactions?ClientID=123&ClientTransactionID=321", - "method": "GET", - "sortNum": 45000, - "created": "2024-02-17T00:00:10.455Z", - "modified": "2024-02-17T00:00:51.682Z", - "headers": [], - "params": [ - { - "name": "ClientID", - "value": "123", - "isPath": false - }, - { - "name": "ClientTransactionID", - "value": "321", - "isPath": false - } - ], - "tests": [] - } - ] -} \ No newline at end of file