scopedrivers
Interface AscomInterface
- All Known Implementing Classes:
- Ascom
- public interface AscomInterface
Insert the type's description here.
Creation date: (7/20/01 3:18:27 PM)
Method Summary |
void |
abortSlew()
Stops a slew in progress. |
void |
commandBlind(java.lang.String command)
Send a string comand directly to the telescope without expecting response data. |
boolean |
commandBool(java.lang.String command)
Send a string comand to the telescope, returning a true/false response
Remarks: If you use this feature of the Telescope driver interface, your application will be dependent on
the low-level protocol used by the particular scope you are connected to. |
java.lang.String |
commandString(java.lang.String command)
Send a string comand to the telescope, returning the response string
Remarks: If you use this feature of the Telescope driver interface, your application will be dependent on
the low-level protocol used by the particular scope you are connected to. |
void |
findHome()
Locates the telescope's "home" position
Remarks: Raises an error if there is a problem. |
void |
park()
Move the telescope to its home position and stop tracking motion
Remarks: Raises an error if there is a problem communicating with the telescope or if parking fails. |
void |
setPark()
Sets the telescope's park position to be its current position
Remarks: Raises an error if there is a problem. |
void |
setupDialog()
Displays a setup dialog, allowing the user to set telescope-specific values such as baud rate,
geodetic position, etc. |
void |
slewToCoordinates(double rightAscension,
double declination)
Move the telescope to the given coordinates, return when slew is complete
Remarks: Raises an error if the slew fails. |
void |
slewToCoordinatesAsync(double rightAscension,
double declination)
Move the telescope to the given coordinates, return immediately after starting the slew. |
void |
slewToTarget()
Move the telescope to the TargetRightAscension and TargetDeclination coordinates, return when slew complete. |
void |
slewToTargetAsync()
Move the telescope to the TargetRightAscension and TargetDeclination coordinates,
returns immediately after starting the slew. |
void |
syncToCoordinates(double rightAscension,
double declination)
Matches the scope's coordinates to the given coordinates. |
void |
syncToTarget()
Matches the telescope's current coordinates to Ascom.TargetRightAscension and Ascom.TargetDeclination
Remarks: Raises an error if matching fails. |
void |
unpark()
Start tracking from the parked position, valid only after Park(). |
abortSlew
public void abortSlew()
- Stops a slew in progress. Valid only after a call to Ascom.SlewToTargetAsync or
Ascom.SlewToCoordinatesAsync. Does nothing if no slew is in progress.
Creation date: (7/20/01 3:19:45 PM)
commandBlind
public void commandBlind(java.lang.String command)
throws java.lang.Exception
- Send a string comand directly to the telescope without expecting response data.
Remarks: If you use this feature of the Telescope driver interface, your application will be dependent
on the low-level protocol used by the particular scope you are connected to. Thus your application will
not work with any arbitrary type of telescope.
Raises an error if there is a problem communicating with the telescope.
Creation date: (7/20/01 3:21:25 PM)
- Parameters:
command
- java.lang.String The raw string to be sent to the telescope
commandBool
public boolean commandBool(java.lang.String command)
throws java.lang.Exception
- Send a string comand to the telescope, returning a true/false response
Remarks: If you use this feature of the Telescope driver interface, your application will be dependent on
the low-level protocol used by the particular scope you are connected to. Thus your application will not work
with any arbitrary type of telescope.
Raises an error if there is a problem communicating with the telescope.
The returned value is the Automation-compatible Boolean type, True or False. It is the responsibility of the
driver implementing this interface to translate raw response data to True/False values for return.
If you want to see the raw response string, see AscomInterface.CommandString().
Creation date: (7/20/01 3:23:10 PM)
- Parameters:
command
- java.lang.String The raw string to be sent to the telescope- Returns:
- boolean True if the response indicated true or success, else False
commandString
public java.lang.String commandString(java.lang.String command)
throws java.lang.Exception
- Send a string comand to the telescope, returning the response string
Remarks: If you use this feature of the Telescope driver interface, your application will be dependent on
the low-level protocol used by the particular scope you are connected to. Thus your application will not
work with any arbitrary type of telescope.
Raises an error if there is a problem communicating with the telescope.
Creation date: (7/20/01 3:24:15 PM)
- Parameters:
command
- java.lang.String The raw string to be sent to the telescope- Returns:
- java.lang.String The response data from the telescope resulting from the sent command.
findHome
public void findHome()
throws java.lang.Exception
- Locates the telescope's "home" position
Remarks: Raises an error if there is a problem.
Creation date: (7/20/01 3:25:17 PM)
park
public void park()
throws java.lang.Exception
- Move the telescope to its home position and stop tracking motion
Remarks: Raises an error if there is a problem communicating with the telescope or if parking fails.
Creation date: (7/20/01 3:25:53 PM)
setPark
public void setPark()
throws java.lang.Exception
- Sets the telescope's park position to be its current position
Remarks: Raises an error if there is a problem.
Creation date: (7/20/01 3:26:27 PM)
setupDialog
public void setupDialog()
- Displays a setup dialog, allowing the user to set telescope-specific values such as baud rate,
geodetic position, etc.
.
Creation date: (7/20/01 3:27:23 PM)
slewToCoordinates
public void slewToCoordinates(double rightAscension,
double declination)
throws java.lang.Exception
- Move the telescope to the given coordinates, return when slew is complete
Remarks: Raises an error if the slew fails.
The slew may fail if the target coordinates are beyond limits imposed within the driver component.
Such limits include airmass maximum, mechanical constraints imposed by the mount or attached instruments,
building or dome enclosure restrictions, etc. The target coordinates are copied to
Ascom.TargetRightAscension and Ascom.TargetDeclination whether or not the slew succeeds.
Creation date: (7/20/01 3:28:44 PM)
- Parameters:
rightAscension
- double The destination right ascension (local topocentric, hours).
Copied to Ascom.TargetRightAscension.declination
- double The destination declination (local topocentric, degrees, positive North).
Copied to Ascom.TargetDeclination.
slewToCoordinatesAsync
public void slewToCoordinatesAsync(double rightAscension,
double declination)
throws java.lang.Exception
- Move the telescope to the given coordinates, return immediately after starting the slew.
Remarks: Raises an error if starting the slew failed.
Returns immediately after starting the slew. The client may monitor the progress of the slew by reading
the Ascom.RightAscension, Ascom.Declination, and Ascom.Slewing properties during the slew.
When the slew completes, Ascom.Slewing becomes False.
The slew may fail to start if the target coordinates are beyond limits imposed within the driver component.
Such limits include airmass maximum, mechanical constraints imposed by the mount or attached instruments,
building or dome enclosure restrictions, etc. The target coordinates are copied to
Ascom.TargetRightAscension and Ascom.TargetDeclination whether or not the slew succeeds.
Creation date: (7/20/01 3:28:44 PM)
- Parameters:
rightAscension
- double The destination right ascension (local topocentric, hours).
Copied to Ascom.TargetRightAscension.declination
- double The destination declination (local topocentric, degrees, positive North).
Copied to Ascom.TargetDeclination.
slewToTarget
public void slewToTarget()
throws java.lang.Exception
- Move the telescope to the TargetRightAscension and TargetDeclination coordinates, return when slew complete.
Remarks: Raises an error if the slew failed.
The slew may fail if the target coordinates are beyond limits imposed within the driver component.
Such limits include airmass maximum, mechanical constraints imposed by the mount or attached instruments,
building or dome enclosure restrictions, etc.
Creation date: (7/20/01 3:30:28 PM)
slewToTargetAsync
public void slewToTargetAsync()
throws java.lang.Exception
- Move the telescope to the TargetRightAscension and TargetDeclination coordinates,
returns immediately after starting the slew.
Remarks: Raises an error if starting the slew failed.
Returns immediately after starting the slew. The client may monitor the progress of the slew by reading
the Ascom.RightAscension, Ascom.Declination, and Ascom.Slewing properties during the slew.
When the slew completes, Ascom.Slewing becomes False.
The slew may fail to start if the target coordinates are beyond limits imposed within the driver component.
Such limits include airmass maximum, mechanical constraints imposed by the mount or attached instruments,
building or dome enclosure restrictions, etc.
Creation date: (7/20/01 3:30:28 PM)
syncToCoordinates
public void syncToCoordinates(double rightAscension,
double declination)
throws java.lang.Exception
- Matches the scope's coordinates to the given coordinates.
Remarks: Sets Ascom.TargetRightAscension to the given right ascension, and Ascom.Declination
to the given declination. Raises an error if matching fails.
Creation date: (7/20/01 3:28:44 PM)
- Parameters:
rightAscension
- double The corrected right ascension (local topocentric, hours).
Copied to Ascom.TargetRightAscension.declination
- double The corrected declination (local topocentric, degrees, positive North).
Copied to Ascom.TargetDeclination.
syncToTarget
public void syncToTarget()
throws java.lang.Exception
- Matches the telescope's current coordinates to Ascom.TargetRightAscension and Ascom.TargetDeclination
Remarks: Raises an error if matching fails.
Creation date: (7/20/01 3:30:28 PM)
unpark
public void unpark()
throws java.lang.Exception
- Start tracking from the parked position, valid only after Park().
Remarks: Raises an error if unparking fails.
Creation date: (7/20/01 3:25:53 PM)