Commands¶

yao¶

yao [OPTIONS] COMMAND [ARGS]...

abort¶

Aborts the current exposure.

yao abort [OPTIONS]

Options

--flush¶: Flush the device after aborting.

--reset¶: Reset the controllers after aborting. This will discard any ongoing exposures or pending readouts.

cleanup¶

Runs the r2 cleanup routine.

yao cleanup [OPTIONS]

Options

--erase¶: Run the erase procedure too.

--cycles <cycles>¶: Number of purge cycles.

--slow¶: Does full flushing for each cycle.

config¶

Manages the configuration of the device.

yao config [OPTIONS] COMMAND [ARGS]...

read¶

Reads the configuration from the controller.

yao 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.

yao 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.

yao disconnect [OPTIONS]

Options

-c, --controller <controller>¶: Controller to command

erase¶

Runs the r2 erase routine.

yao erase [OPTIONS]

expose¶

Exposes the cameras.

yao 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.

yao flush [OPTIONS] [COUNT]

Options

-c, --controller <controller>¶: Controller to command

Arguments

COUNT¶: Optional argument

frame¶

Interacts with the controller buffer frame.

yao frame [OPTIONS] COMMAND [ARGS]...

fetch¶

Low-level command to fetch a buffer and write it to disk.

yao 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.

yao frame status [OPTIONS] CONTROLLER

Arguments

CONTROLLER¶: Required argument

get-command-model¶

Returns a dictionary representation of the command using unclick.

yao get-command-model [OPTIONS] [COMMAND_NAME]

Arguments

COMMAND_NAME¶: Optional argument

get-window¶

Outputs the current exposure window.

yao get-window [OPTIONS]

get_schema¶

Returns the schema of the actor as a JSON schema.

yao get_schema [OPTIONS]

hartmann¶

Takes Hartmann image(s).

yao hartmann [OPTIONS] EXPTIME

Options

-s, --side <side>¶

Position of the Hartmann door. With both, takes two arcs with different doors in.

Options:: both | left | right

--sub-frame¶: Read a subregion of the frame.

Arguments

EXPTIME¶: Required argument

help¶

Shows the help.

yao help [OPTIONS] [PARSER_COMMAND]

Arguments

PARSER_COMMAND¶: Optional argument

init¶

Initialises a controller.

yao 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.

yao keyword [OPTIONS] KEYWORD

Arguments

KEYWORD¶: Required argument

mech¶

Interface to the specMech controller.

yao mech [OPTIONS] COMMAND [ARGS]...

ack¶

Acknowledges the specMech has rebooted and informs the user.

yao mech ack [OPTIONS]

close¶

Closes left or right Hartmann doors, or the shutter.

yao mech close [OPTIONS] {left|right|shutter}...

Arguments

MECHANISMS¶: Required argument(s)

disconnect¶

Closes the connection to the specMech.

yao mech disconnect [OPTIONS]

fan¶

Turns the speMech fan on/off.

yao mech fan [OPTIONS] {on|off}

Arguments

MODE¶: Required argument

move¶

Commands the collimator motors.

Without flags moves are relative from the current position and move all motors concurrently.

yao mech move [OPTIONS] [POSITION]

Options

--motor <motor>¶

Move only this motor.

Options:: a | b | c

--absolute¶: Moves one motor to an absolute position.

--wait, --no-wait¶: Waits until the motor has .

--tolerance <tolerance>¶: Collimator positioning tolerance.

--center¶: Send the motors to their home positions.

--center-position <center_position>¶: Absolute position for homing all the motors.

Arguments

POSITION¶: Optional argument

open¶

Opens left or right Hartmann doors, or the shutter.

yao mech open [OPTIONS] {left|right|shutter}...

Arguments

MECHANISMS¶: Required argument(s)

reboot¶

Reboots the controller. A reconnect and acknowledge are needed afterewards.

yao mech reboot [OPTIONS]

reconnect¶

Recreates the connection to the specMech.

yao mech reconnect [OPTIONS]

set-time¶

Set the clock time of the specMech.

yao mech set-time [OPTIONS] TIME

Arguments

TIME¶: Required argument

status¶

Queries specMech for all status responses.

yao mech status [OPTIONS] [[time|version|environment|vacuum|motors|motor-a|mot
                or-b|motor-c|orientation|pneumatics|specmech]]

Options

-d, --debug¶: Uses debug status in outputs..

Arguments

STAT¶: Optional argument

talk¶

Send data string directly as-is to the specMech.

yao mech talk [OPTIONS] DATA

Arguments

DATA¶: Required argument

ping¶

Pings the actor.

yao ping [OPTIONS]

power¶

Powers on/off a controller.

yao power [OPTIONS] [[on|off]]

Options

-c, --controller <controller>¶: Controller to command

Arguments

MODE¶: Optional argument

purge¶

Sets the purge routine on/off.

yao purge [OPTIONS] COMMAND [ARGS]...

off¶

Sets DoPurge=0.

yao purge off [OPTIONS]

on¶

Sets DoPurge=1.

yao purge on [OPTIONS]

read¶

Finishes the ongoing exposure.

yao 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).

yao 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.

yao 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.

yao 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.

yao 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.

yao 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.

yao system [OPTIONS]

Options

-c, --controller <controller>¶: Controller to command

talk¶

Sends a command to the controller.

yao talk [OPTIONS] COMMAND

Options

-c, --controller <controller>¶: Controller to command

Arguments

COMMAND¶: Required argument

version¶

Reports the version.

yao version [OPTIONS]

wait-until-idle¶

Wait until the spectrograph status is IDLE and there is no READOUT_PENDING.

yao wait-until-idle [OPTIONS]

Options

--allow-errored¶: Returns even if the spectrograph status is ERROR as long as it is IDLE.