Advanced API

11 days ago

Change #3f0cd86a

2.2.3

Compare

3 structure changes including:

2 Additions

1 Modification

Modified 1

GET /image/{index}

Query
raw_fits query parameter Added

Added 2

GET /equipment/mount/sync

GET /profile/horizon

Apr 25, 2025

Change #ff5c358e

2.2.2

Compare

1 structure change including:

1 Addition

Added 1

GET /application/get-tab

Apr 16, 2025

Change #f0585365

2.2.0

Compare

1 structure change including:

1 Modification

Modified 1

GET /equipment/dome/info

Response
200 response Modified
- application/json content type Modified
  - Response property Modified
    - ShutterStatus, DriverCanFollow, CanSetShutter, CanSetPark, CanSetAzimuth, CanSyncAzimuth, CanPark, CanFindHome, AtPark, AtHome, DriverFollowing, Slewing, Azimuth, SupportedActions, Connected, Name, DisplayName, Description, DriverInfo, DriverVersion, DeviceId properties Modified
      - Properties are no longer required
    - IsFollowing, IsSynchronized properties Added

Apr 16, 2025

Change #2d478e2c

2.2.0

Compare

4 structure changes including:

3 Additions

1 Modification

Modified 1

GET /equipment/dome/slew

Query
waitToFinish query parameter Added

Added 3

GET /equipment/dome/home

GET /equipment/dome/park

GET /equipment/dome/set-park-position

Apr 1, 2025

Change #844c16d3

2.2.0

Compare

1 structure change including:

1 Modification

Modified 1

GET /equipment/dome/set-follow

Query
enabled query parameter Added

Mar 29, 2025

Change #248d4057

2.2.0

Breaking

Compare

39 structure changes including:

27 Additions

12 Modifications

Modified 12 Breaking

GET /equipment/camera/capture

Query
save query parameter Added

GET /equipment/camera/connect

Query
skipRescan query parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
to query parameter Added

GET /equipment/dome/connect

Query
skipRescan query parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
to query parameter Added

GET /equipment/filterwheel/connect

Query
skipRescan query parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
to query parameter Added

GET /equipment/flatdevice/connect

Query
skipRescan query parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
to query parameter Added

GET /equipment/focuser/connect

Query
skipRescan query parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
to query parameter Added

GET /equipment/guider/connect

Query
skipRescan query parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
to query parameter Added

GET /equipment/mount/connect

Query
skipRescan query parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
to query parameter Added

GET /equipment/rotator/connect

Query
skipRescan query parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
to query parameter Added

GET /equipment/safetymonitor/connect

Query
skipRescan query parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
to query parameter Added

GET /equipment/switch/connect

Query
skipRescan query parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
to query parameter Added

GET /equipment/weather/connect

Query
skipRescan query parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
to query parameter Added

Added 27

GET /sequence/state

GET /sequence/edit

GET /image/thumbnail/{index}

GET /equipment/weather/rescan

GET /equipment/weather/list-devices

GET /equipment/switch/rescan

GET /equipment/switch/list-devices

GET /equipment/camera/capture/statistics

GET /equipment/camera/list-devices

GET /equipment/camera/rescan

GET /equipment/dome/list-devices

GET /equipment/dome/rescan

GET /equipment/filterwheel/list-devices

GET /equipment/filterwheel/rescan

GET /equipment/flatdevice/list-devices

GET /equipment/flatdevice/rescan

GET /equipment/focuser/list-devices

GET /equipment/focuser/rescan

GET /equipment/guider/list-devices

GET /equipment/guider/rescan

GET /equipment/mount/list-devices

GET /equipment/mount/rescan

GET /equipment/mount/set-park-position

GET /equipment/rotator/list-devices

GET /equipment/rotator/rescan

GET /equipment/safetymonitor/list-devices

GET /equipment/safetymonitor/rescan

Feb 21, 2025

Change #7caae9bb

2.1.8

Breaking

Compare

1 structure change including:

1 Modification

Modified 1 Breaking

GET /flats/status

Response
200 response Modified
- application/json content type Modified
  - Response property Modified
    - Type went from string to object
      Breaking
    - CompletedIterations, TotalIterations, State properties Added

Feb 21, 2025

Change #ac7ccdbb

2.1.8

Compare

11 structure changes including:

8 Additions

3 Modifications

Modified 3

GET /equipment/mount/slew

Query
waitForResult query parameter Added

GET /image-history

Response
200 response Modified
- application/json content type Modified
  - Response property Modified
    - array-1 alternative Modified
Query
imageType query parameter Added

GET /image/{index}

Query
debayer, bayerPattern, autoPrepare, imageType query parameters Added

Added 8

GET /equipment/mount/slew/stop

GET /flats/auto-brightness

GET /flats/auto-exposure

GET /flats/skyflat

GET /flats/status

GET /flats/stop

GET /flats/trained-dark-flat

GET /flats/trained-flat

Feb 4, 2025

Change #b8a3de55

2.1.7

Breaking

Compare

11 structure changes including:

5 Additions

6 Modifications

Modified 6 Breaking

GET /equipment/camera/info

Response
200 response Modified
- application/json content type Modified
  - Response property Modified
    - CameraState, SensorType properties Modified
      - Type went from integer to string
        Breaking

GET /equipment/dome/info

Response
200 response Modified
- application/json content type Modified
  - Response property Modified
    - ShutterStatus property Modified
      - Type went from integer to string
        Breaking

GET /equipment/flatdevice/info

Response
200 response Modified
- application/json content type Modified
  - Response property Modified
    - CoverState property Modified
      - Type went from integer to string
        Breaking

GET /equipment/mount/info

Response
200 response Modified
- application/json content type Modified
  - Response property Modified
    - SiderealTime, RightAscension, Declination, SiteLatitude, SiteLongitude, SiteElevation, RightAscensionString, DeclinationString, Coordinates, TimeToMeridianFlip, Altitude, AltitudeString, AzimuthString, SiderealTimeString, HoursToMeridianString, AtPark, TrackingRate, TrackingEnabled, AtHome, CanFindHome, CanPark, CanSetPark, CanSetTrackingEnabled, CanSetDeclinationRate, CanSetRightAscensionRate, HasUnknownEpoch, TimeToMeridianFlipString, Slewing, GuideRateRightAscensionArcsecPerSec, GuideRateDeclinationArcsecPerSec, CanMovePrimaryAxis, CanMoveSecondaryAxis, PrimaryAxisRates, SecondaryAxisRates, SupportedActions, CanPulseGuide, IsPulseGuiding, CanSetPierSide, CanSlew, UTCDate properties Modified
      - Properties are no longer required
    - SideOfPier, EquatorialSystem, AlignmentMode properties Modified
      - Properties are no longer required
      - Type went from integer to string
        Breaking
    - Azimuth property Modified
      - Property is no longer required
      - Type went from integer to number
        Breaking
    - TrackingModes property Modified
      - Property is no longer required
      - Type went from array[integer] to array[string]
        Breaking

GET /framing/slew

Query
waitForResult query parameter Added

GET /profile/show

Response
200 response Modified
- application/json content type Modified
  - Response property Modified
    - ApplicationSettings, CameraSettings, DomeSettings, FilterWheelSettings, FlatWizardSettings, FocuserSettings, FramingAssistantSettings, GuiderSettings, ImageFileSettings, ImageSettings, PlanetariumSettings, PlateSolveSettings, RotatorSettings, TelescopeSettings, ImageHistorySettings properties Modified

Added 5

GET /application/plugins

GET /livestack/start

GET /livestack/stop

GET /livestack/{target}/{filter}

GET /version

Jan 29, 2025

Change #6aad7492

2.1.6

Compare

5 structure changes including:

2 Additions

3 Modifications

Modified 3

GET /application/screenshot

Response
200 response Modified
- image/png, image/jpg content types Added
Query
stream query parameter Added

GET /equipment/camera/capture

Response
200 response Modified
- image/png, image/jpg content types Added
Query
stream, omitImage, waitForResult query parameters Added

GET /image/{index}

Response
200 response Modified
- image/png, image/jpg content types Added
Query
stream query parameter Added

Added 2

GET /equipment/camera/set-binning

GET /framing/determine-rotation

Jan 25, 2025

Change #b43e24df

2.1.5

Compare

5 structure changes including:

5 Additions

Added 5

GET /equipment/dome/set-follow

GET /equipment/dome/slew

GET /equipment/dome/sync

GET /equipment/mount/flip

GET /equipment/mount/slew

Jan 22, 2025

Change #23a8e346

2.1.4

Compare

4 structure changes including:

2 Additions

2 Modifications

Modified 2

GET /equipment/guider/info

Response
200 response Modified
- application/json content type Modified
  - Response property Modified
    - State property Added

GET /equipment/guider/start

Query
calibrate query parameter Added

Added 2

GET /equipment/guider/clear-calibration

GET /equipment/guider/graph

Jan 18, 2025

Change #a7dbc572

2.1.3

Compare

12 structure changes including:

12 Modifications

Modified 12

GET /equipment/camera/connect

Query
skipRescan query parameter Added

GET /equipment/dome/connect

Query
skipRescan query parameter Added

GET /equipment/filterwheel/connect

Query
skipRescan query parameter Added

GET /equipment/flatdevice/connect

Query
skipRescan query parameter Added

GET /equipment/focuser/connect

Query
skipRescan query parameter Added

GET /equipment/guider/connect

Query
skipRescan query parameter Added

GET /equipment/mount/connect

Query
skipRescan query parameter Added

GET /equipment/rotator/connect

Query
skipRescan query parameter Added

GET /equipment/safetymonitor/connect

Query
skipRescan query parameter Added

GET /equipment/switch/connect

Query
skipRescan query parameter Added

GET /equipment/weather/connect

Query
skipRescan query parameter Added

GET /image/{index}

Query
factor, blackClipping, unlinked query parameters Added

Jan 17, 2025

Change #097f007c

1.0.0

Compare

Added more endpoints to flatdevice:
- flatdevice/set-cover to open or close the cover
- flatdevice/set-light to toggle the light on or off
- flatdevice/set-brightness to change the brightness of the flatpanel
Added sequence/set-target to update the target in a target container

4 structure changes including:

4 Additions

Added 4

GET /equipment/flatdevice/set-brightness

GET /equipment/flatdevice/set-cover

GET /equipment/flatdevice/set-light

GET /sequence/set-target

Jan 9, 2025

Change #903bffb8

2.0.0

Compare

profile/change-value fixes

framing/set-source added

camera/set-readout added to set the readout mode

version now returns the Plugin Version instead of an Independent Version number

2 structure changes including:

2 Additions

Added 2

GET /equipment/camera/set-readout

GET /framing/set-source

Jan 5, 2025

Change #7a95ee5c

2.0.0

Breaking

Compare

Moved GlobalTriggers to the top of the returned json as it seems to have caused confusion
Added the field ImageType to the IMAGE-SAVE Event and image-history
Removed the Id field from image-history, just use the index of the Image in the returned Array
All Image Types (LIGHT, DARK, BIAS, FLAT, SNAPSHOT) now raise an IMAGE-SAVE event
Event watchers are now started independently of the api, therefore Events can still be retrieved using event-history even if the api wasn't running before.

5 structure changes including:

1 Addition

4 Modifications

Modified 4 Breaking

GET /equipment/focuser/last-af

Response
200 response Modified
- application/json content type Modified
  - Response property Modified
    - RSquares property Modified

GET /image-history

Response
200 response Modified
- application/json content type Modified
  - Response property Modified
    - array-1 alternative Modified

GET /profile/show

Response
200 response Modified
- application/json content type Modified
  - Response property Modified
    - PluginSettings property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /sequence/list-available

Response
200 response Modified
- application/json content type Modified
  - Response property Modified
    - Type went from array[string] to array[object]
      Breaking
    - object property Added

Added 1

GET /sequence/reset

Dec 31, 2024

Change #c514c95c

2.0.0

Breaking

Compare

2 structure changes including:

2 Modifications

Modified 2 Breaking

GET /equipment/mount/info

Response
200 response Modified
- application/json content type Modified
  - Response property Modified
    - SiteElevation, TimeToMeridianFlip properties Modified
      - Type went from integer to number
        Breaking

GET /sequence/json

Response
200 response Modified
- application/json content type Modified
  - Response, Error, StatusCode, Success, Type properties Added

Dec 28, 2024

Change #42964c7e

2.0.0

Breaking

Compare

6 structure changes including:

6 Modifications

Modified 6 Breaking

GET /equipment/camera/cool

Query
minutes query parameter Modified
- Query parameter is now required
  Breaking

GET /equipment/camera/info

Response
200 response Modified
- application/json content type Modified
  - Response property Modified
    - TargetTemp, AtTargetTemp properties Added

GET /equipment/camera/warm

Query
minutes query parameter Added

GET /equipment/filterwheel/info

Response
200 response Modified
- application/json content type Modified
  - Response property Modified
    - AvailableFilters property Modified
      - Property is no longer required
    - CanSetFilter property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - IsMoving, SupportedActions, SelectedFilter properties Added

GET /equipment/rotator/move

Query
position query parameter Modified
- Type went from integer(int32) to number
  Breaking

GET /equipment/rotator/move-mechanical

Query
position query parameter Modified
- Type went from integer(int32) to number
  Breaking

Dec 26, 2024

Change #27f97b8c

2.0.0

Compare

Do not miss any Advanced API changes, ever again

Changelog

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

AdvancedAPI 2.1.2.0

2.1.0.0 beta 7

ninaAPI 2.1.0.0 beta 6

API structure has changed

API structure has changed

API documentation has been created