next up previous
Next: Functions for Data Output Up: Functions Previous: Functions

Driver Access functions

int driver_init(void*)
This function should assign all necessary variable values, and prepare the instrument for use.

int shutter()
This function will open the shutter on the instrument, this is not strictly necessary. The function returns 0 on success and -1 on failure. If the function is not implemented simply Print an error message and return 0.

int expose(int time, a_image*)
This is the entrance point to grab an image from an imaging device. time is the exposure time in milliseconds. a_image* is a pointer to an Image data struct. (defined in section 2.1) The function returns 0 on success and -1 when there is a failure.

int tcs_get(a_pointing_object*)
This is the function for filling a pointing_object with data from the Telescope.Return 0 on success and -1 on an error.

int tcs_send(a_pointing_object*)
This is the function to send new coordinates to the TCS for goto. Returns 0 on success, -1 on failure.

int tcs_com(char *)
This is reserved for sending individual commands and command sequences to the TCS. The driver maintainer should provide this interface, but it should not be relied upon in applications without some sort of translation layer. Primarily used for scripting. Returns 0 on success, -1 on failure.

int fw_home(int fw)
This function will home the filter wheel designated by fw in the global a_State struct. it is not strictly necessary, if it is deprecated in your driver make sure to document that fact.

int fw_setpos(int fw,int pos)
This is the function to move the filter wheel fw to a position pos


next up previous
Next: Functions for Data Output Up: Functions Previous: Functions
Aaron Smith 2004-03-04