Module azcam.tools.ascom.controller_ascom
Contains the ControllerASCOM class.
Classes
class ControllerASCOM (tool_id='controller', description=None)
-
The controller class for cameras using ASCOM.
Args
tool_id
- tool name
description
- description of this tool
Ancestors
Instance variables
var description
-
Inherited from:
Controller
.description
descriptive tool name
var enabled
-
Inherited from:
Controller
.enabled
1 when tool is enabled
var exposure_time
-
Inherited from:
Controller
.exposure_time
exposure time (secs)
var initialized
-
Inherited from:
Controller
.initialized
1 when tool has been initialized
var interface_type
-
Inherited from:
Controller
.interface_type
interface type (0 = demo, 4 = PCIe)
var is_reset
-
Inherited from:
Controller
.is_reset
1 when tool has been reset
var reset_flag
-
Inherited from:
Controller
.reset_flag
True if the controller has been reset
var tool_id
-
Inherited from:
Controller
.tool_id
name used to reference the tool ("controller", "display", …)
var verbosity
-
Inherited from:
Controller
.verbosity
verbosity for debug, >0 is more verbose
Methods
def define_keywords(self)
-
Inherited from:
Controller
.define_keywords
Defines and resets keywords.
def delete_keyword(self, keyword: str)
-
Inherited from:
Controller
.delete_keyword
Delete a keyword.
Args
keyword
- keyword
def flush(self, cycles=1)
-
Inherited from:
Controller
.flush
Flush or clear out the sensor. Returns after clearing is finished, which could take many seconds.
Args
cycles
- number of times to flush sensor
def get_exposuretime(self)
def get_keyword(self, keyword: str) ‑> list
-
Inherited from:
Controller
.get_keyword
Return a keyword value, its comment string, and type. Comment always returned in double quotes, even if empty.
Args
keyword
- name of keyword
…
def get_keywords(self) ‑> list
-
Inherited from:
Controller
.get_keywords
Return a list of all keyword names.
Returns
keywords
- list of all keywords
def get_pixels_remaining(self)
-
Return number of remaining pixels to be read (counts down).
def initialize(self)
-
Initialize the controller interface.
def is_imageready(self, wait=0)
-
Return True if image is ready.
def read_header(self) ‑> list
-
Inherited from:
Controller
.read_header
Reads and returns current header data.
Returns
list
ofheader lines
- [Header[]]: Each element Header[i] contains the sublist (keyword, value, …
def reset(self)
-
Reset the controller.
def set_exposuretime(self, exposure_time)
-
Write the exposure time (in seconds) to the controller.
def set_keyword(self, keyword: str, value: Any, comment: str = 'none', typestring: str = 'none')
-
Inherited from:
Controller
.set_keyword
Set a keyword value, comment, and type.
Args
keyword
- keyword
value
- value of keyword
comment
- comment string
typestring
- one of …
def set_roi(self)
-
Inherited from:
Controller
.set_roi
Sets ROI parameters values in the controller based on focalplane parameters.
def set_shutter(self, state: bool, shutter_id: int = 0)
-
Inherited from:
Controller
.set_shutter
Open or close controller shutter.
Args
state
- True to open shutter, False to close shutter
shutter_id
- shutter ID number
def set_shutter_state(self, state)
-
Open or close controller shutter.
def start_exposure(self)
-
Start exposure (integration).
def start_idle(self)
-
Inherited from:
Controller
.start_idle
Start idle clocking.
def stop_idle(self)
-
Inherited from:
Controller
.stop_idle
Stop idle clocking.
def update_exposuretime_remaining(self)
-
Return remaining exposure time (in seconds).
def update_header(self)
-
Inherited from:
Controller
.update_header
Update the header, reading current data. Deletes all keywords if the object is not enabled.