com.raben.telescope.comm
Interface TelescopeInterface

All Known Implementing Classes:

CelestronTelescope, MeadeTelescope

public interface TelescopeInterface

Define the telescope interface

Version:

$Revision: 1.2 $ $Date: 2003/09/08 16:29:53 $

Author:

Vern Raben

Method Summary

void	cancelGoTo() Cancel current GoTo command
void	close() Close connection to telescope
void	connect() Initialize connection to telescope
java.awt.geom.Point2D	getAzimuthAltitude() Get current coordinate
java.awt.geom.Point2D	getGpsCoordinate() Get telescope coordinate from GPS interface
java.util.Calendar	getGpsDateTime() Get Calendar date from GPS interface
java.lang.String	getHandControlVersion() Get controller version
java.util.Properties	getProperties() Get telescope properties
java.awt.geom.Point2D	getRightAscensionDeclination() Get current coordinate
TelescopeModel	getTelescopeModel() Get telescope model
void	goToAzimuthAltitude(java.awt.geom.Point2D coordinate) GoTo the specified coordinate in azimuth and altitude
void	goToRightAscensionDeclination(java.awt.geom.Point2D coordinate) Go to the specified coordinate in right ascension/declination
boolean	isAligned() Check if telescope is aligned
boolean	isCommunicating() Check if telescope is communitating with serial port
boolean	isConnected() Check if telescope is connected
boolean	isDebug() Get debug flag
boolean	isGpsLinked() Check if GPS is linked
boolean	isSlewing() Check if telescope is slewing
void	moveInAltitude(boolean direction, int rate) Move telescope in altitude
void	moveInAzimuth(boolean direction, int rate) Move telescope in azimuth
void	setAltitudeTrackingRate(int trackRate) Set altitude tracking rate Note - tracking will return to default in approximately 20 seconds unless tracking is turned off @see setTrackingMode
void	setAzimuthTrackingRate(int trackRate) Set azimuth tracking rate Note - tracking will return to default in approximately 20 seconds unless tracking is turned off @see setTrackingMode
void	setDebug(boolean debug) Set debug flag
void	setProperties(java.util.Properties props) Set telescope properties
void	setTelescopeModel(TelescopeModel model) Set the telescope model
void	setTrackingMode(int mode) Set telescope tracking mode

Method Detail

cancelGoTo

public void cancelGoTo()
                throws java.io.IOException

Cancel current GoTo command

Throws:

java.io.IOException - may occur

goToRightAscensionDeclination

public void goToRightAscensionDeclination(java.awt.geom.Point2D coordinate)
                                   throws java.io.IOException

Go to the specified coordinate in right ascension/declination

Parameters:

coordinate - in right ascension and declination

Throws:

java.io.IOException - may occur

goToAzimuthAltitude

public void goToAzimuthAltitude(java.awt.geom.Point2D coordinate)
                         throws java.io.IOException

GoTo the specified coordinate in azimuth and altitude

Parameters:

coordinate - in azimuth and altitude

Throws:

java.io.IOException - may occur

getRightAscensionDeclination

public java.awt.geom.Point2D getRightAscensionDeclination()
                                                   throws java.io.IOException

Get current coordinate

Returns:

Coordinate in right ascension declination

Throws:

java.io.IOException - may occur

getAzimuthAltitude

public java.awt.geom.Point2D getAzimuthAltitude()
                                         throws java.io.IOException

Get current coordinate

Returns:

Coordinate in azimuth and altitude

Throws:

java.io.IOException - may occur

isAligned

public boolean isAligned()
                  throws java.io.IOException

Check if telescope is aligned

Returns:

True if telescope is aligned, false otherwise

Throws:

java.io.IOException - may occur

isCommunicating

public boolean isCommunicating()
                        throws java.io.IOException

Check if telescope is communitating with serial port

Returns:

True if communication was successful, false otherwise

Throws:

java.io.IOException - may be thrown

isSlewing

public boolean isSlewing()
                  throws java.io.IOException

Check if telescope is slewing

Returns:

True if slewing, false otherwise

Throws:

java.io.IOException - may occur

getHandControlVersion

public java.lang.String getHandControlVersion()
                                       throws java.io.IOException

Get controller version

Returns:

String

Throws:

java.io.IOException - may occur

setTrackingMode

public void setTrackingMode(int mode)
                     throws java.io.IOException

Set telescope tracking mode

Parameters:

mode - 0=off, 1=alt/az, 2= eq-n, 3=eq-s

Throws:

java.io.IOException - may occur

connect

public void connect()
             throws java.io.IOException

Initialize connection to telescope

Throws:

java.io.IOException - may occur

isConnected

public boolean isConnected()

Check if telescope is connected

Returns:

true if connected

close

public void close()

Close connection to telescope

setTelescopeModel

public void setTelescopeModel(TelescopeModel model)

Set the telescope model

Parameters:

model - of telescope @see TelescopeModel

getTelescopeModel

public TelescopeModel getTelescopeModel()

Get telescope model

Returns:

TelescopeModel

isGpsLinked

public boolean isGpsLinked()
                    throws java.io.IOException

Check if GPS is linked

Returns:

boolean true if GPS is linked, false otherwise

Throws:

java.io.IOException - may occur

getGpsDateTime

public java.util.Calendar getGpsDateTime()
                                  throws java.io.IOException

Get Calendar date from GPS interface

Returns:

Calendar

Throws:

java.io.IOException - may occur

getGpsCoordinate

public java.awt.geom.Point2D getGpsCoordinate()
                                       throws java.io.IOException

Get telescope coordinate from GPS interface

Returns:

Geographic coordinate of telescope in degrees

Throws:

java.io.IOException - may occur

setProperties

public void setProperties(java.util.Properties props)

Set telescope properties

Parameters:

props - Properties for setting up telescope such as comm port, baud rate etc, refer to Javadoc for particular telescope model

getProperties

public java.util.Properties getProperties()

Get telescope properties

Returns:

Properties

setDebug

public void setDebug(boolean debug)

Set debug flag

Parameters:

debug - flag

isDebug

public boolean isDebug()

Get debug flag

Returns:

boolean

setAzimuthTrackingRate

public void setAzimuthTrackingRate(int trackRate)
                            throws java.io.IOException

Set azimuth tracking rate Note - tracking will return to default in approximately 20 seconds unless tracking is turned off @see setTrackingMode

Parameters:

trackRate - in arc-sec/sec

Throws:

java.io.IOException - may occur

setAltitudeTrackingRate

public void setAltitudeTrackingRate(int trackRate)
                             throws java.io.IOException

Set altitude tracking rate Note - tracking will return to default in approximately 20 seconds unless tracking is turned off @see setTrackingMode

Parameters:

trackRate - in arc-sec/sec

Throws:

java.io.IOException - may occur

moveInAzimuth

public void moveInAzimuth(boolean direction,
                          int rate)
                   throws java.io.IOException

Move telescope in azimuth

Parameters:

direction - true = right, false = left

rate - 0=stop,1=slow, 9=fast

java.io.IOException

moveInAltitude

public void moveInAltitude(boolean direction,
                           int rate)
                    throws java.io.IOException

Move telescope in altitude

Parameters:

direction - true = up, false = down

rate - 0=stop, 1=slow, 9=fast

java.io.IOException