Actor commands#
The archon actor replies to the following commands.
archon#
archon [OPTIONS] COMMAND [ARGS]...
abort#
Aborts the exposure.
archon abort [OPTIONS]
Options
- --flush#
Flush the device after aborting.
- --force#
Forces abort.
- --all#
Aborts all the controllers.
config#
Manages the configuration of the device.
archon config [OPTIONS] COMMAND [ARGS]...
read#
Reads the configuration from the controller.
archon config read [OPTIONS] CONTROLLER
Options
- -s, --save#
Saves the configuration to ~/archon_<controller>.acf. Does not output to console. Overwrites previous files.
Arguments
- CONTROLLER#
Required argument
write#
Writes a configuration file to the controller.
archon config write [OPTIONS] CONTROLLER PATH
Options
- -a, --applyall#
Applies the configuration.
- -p, --poweron#
Powers the CCD.
Arguments
- CONTROLLER#
Required argument
- PATH#
Required argument
disconnect#
Disconnects a controller.
archon disconnect [OPTIONS]
Options
- -c, --controller <controller>#
Controller to command
expose#
Exposes the cameras.
archon expose [OPTIONS] [EXPOSURE_TIME]
Options
- -c, --controller <controller>#
Controller to command
- --window-mode <window_mode>#
Exposure window profile.
- --bias#
Take a bias.
- Default:
False
- --dark#
Take a dark.
- --flat#
Take a flat.
- --arc#
Take an arc.
- --object#
Take an object frame.
- --readout, -R, --no-readout#
Whether to read out the frame.
- --async-readout#
When set, readout will be initiated but the command returns immediately as readout begins. If multiple exposures are commanded only the last one will be read out asynchronously.
- --header <header>#
JSON string with additional header keyword-value pairs. Avoid using spaces.
- -d, --delay-readout <delay_readout>#
Slow down the readout by this many seconds.
- -n, --count <count>#
Number of images to take.
- -W, --no-write#
Do not write image after reading.
- --no-shutter#
Do not trigger the shutter.
- --with-dark#
Take a matching dark exposure.
- -s, --seqno <seqno>#
Sequence number for the expossure.
Arguments
- EXPOSURE_TIME#
Optional argument
flush#
Flushes controllers.
archon flush [OPTIONS] [COUNT]
Options
- -c, --controller <controller>#
Controller to command
Arguments
- COUNT#
Optional argument
frame#
Interacts with the controller buffer frame.
archon frame [OPTIONS] COMMAND [ARGS]...
fetch#
Low-level command to fetch a buffer and write it to disk.
archon frame fetch [OPTIONS] CONTROLLER
Options
- -b, --buffer <buffer>#
The frame buffer to read. Defaults to -1 (last written buffer).
- Options:
-1 | 1 | 2 | 3
- -f, --file <file>#
Path where to write the file. Will be overwritten. Defaults to ~/archon_<controller>_NNNN.fits
Arguments
- CONTROLLER#
Required argument
status#
Reads the frame status.
archon frame status [OPTIONS] CONTROLLER
Arguments
- CONTROLLER#
Required argument
get-command-model#
Returns a dictionary representation of the command using unclick.
archon get-command-model [OPTIONS] [COMMAND_NAME]
Arguments
- COMMAND_NAME#
Optional argument
get-window#
Outputs the current exposure window.
archon get-window [OPTIONS]
get_schema#
Returns the schema of the actor as a JSON schema.
archon get_schema [OPTIONS]
help#
Shows the help.
archon help [OPTIONS] [PARSER_COMMAND]
Arguments
- PARSER_COMMAND#
Optional argument
init#
Initialises a controller.
archon init [OPTIONS] [ACF_FILE]
Options
- -a, --applymod <applymod>#
Apply command to send. Multiple instances are allowed. If none is provided, APPLYALL will be sent, followed by a power cycle.
- --power, --no-power#
Power the array after init.
- -c, --controller <controller>#
Controller to command
Arguments
- ACF_FILE#
Optional argument
keyword#
Prints human-readable information about a keyword.
archon keyword [OPTIONS] KEYWORD
Arguments
- KEYWORD#
Required argument
ping#
Pings the actor.
archon ping [OPTIONS]
power#
Powers on/off a controller.
archon power [OPTIONS] [[on|off]]
Options
- -c, --controller <controller>#
Controller to command
Arguments
- MODE#
Optional argument
read#
Finishes the ongoing exposure.
archon read [OPTIONS]
Options
- --header <header>#
JSON string with additional header keyword-value pairs. Avoid using spaces.
- -d, --delay-readout <delay_readout>#
Slow down the readout by this many seconds.
reconnect#
Restarts the socket connection to the controller(s).
archon reconnect [OPTIONS]
Options
- -t, --timeout <timeout>#
Time to wait while (dis)connecting.
- -c, --controller <controller>#
Controller to command
recover#
Recovers a failed exposure.
PATH is either the path to the lockfile of the missing exposure or a directory for which all available lockfiles will be recovered. If PATH is not provided the default path will be used.
archon recover [OPTIONS] [PATH]
Options
- --write-checksum#
Adds the checksum of the recovered files to the checksum file.
- --keep-lock#
Do not remove the lockfile.
Arguments
- PATH#
Optional argument
reset#
Resets the controllers and discards ongoing exposures.
archon reset [OPTIONS]
Options
- -c, --controller <controller>#
Controller to command
set-window#
Sets the exposure window.
A WINDOW-MODE can be specified to load a window profile from the configuration file. Additional flags will modify the parameters in the window mode. The new window settings are always incremental: if a parameter is not defined in the window mode or as a specific flag, the current value is kept. To reload the default window settings from the ACF file use WINDOW-MODE=default or use set-window without arguments.
archon set-window [OPTIONS] [WINDOW_MODE]
Options
- --lines <lines>#
Number of lines to read.
- --pixels <pixels>#
Number of pixels to read.
- --preskiplines <preskiplines>#
Number of lines to pre-skip.
- --postskiplines <postskiplines>#
Number of lines to post-skip.
- --preskippixels <preskippixels>#
Number of pixels to pre-skip.
- --postskippixels <postskippixels>#
Number of pixels to post-skip.
- --overscanlines <overscanlines>#
Number of overscan lines.
- --overscanpixels <overscanpixels>#
Number of overscan pixels.
- --hbin <hbin>#
Horizontal binning.
- --vbin <vbin>#
Vertical binning.
Arguments
- WINDOW_MODE#
Optional argument
status#
Reports the status of the controller.
archon status [OPTIONS]
Options
- -s, --simple#
Only show status bits.
- -d, --debug#
Uses debug status in outputs..
- -c, --controller <controller>#
Controller to command
system#
Reports the status of the controller backplane.
archon system [OPTIONS]
Options
- -c, --controller <controller>#
Controller to command
talk#
Sends a command to the controller.
archon talk [OPTIONS] COMMAND
Options
- -c, --controller <controller>#
Controller to command
Arguments
- COMMAND#
Required argument
version#
Reports the version.
archon version [OPTIONS]
wait-until-idle#
Wait until the spectrograph status is IDLE and there is no READOUT_PENDING.
archon wait-until-idle [OPTIONS]
Options
- --allow-errored#
Returns even if the spectrograph status is ERROR as long as it is IDLE.