Actor commands

The hal actor replies to the following commands.

hal

Usage

hal [OPTIONS] COMMAND [ARGS]...

abort-exposures

Aborts ongoing exposures..

Usage

hal abort-exposures [OPTIONS]

auto-pilot

Starts the auto-pilot mode.

Usage

hal auto-pilot [OPTIONS]

Options

--stop

Stops the auto mode loop after the next stage completes. For an immediate stop use with –now.

--now

Along with –stop, cancels the auto mode loop immediately.

--modify

Modify an ongoing auto loop.

--pause

Pauses the execution of the macro. The current exposures will complete.

--resume

Resumes the execution of the macro.

--count <count>

Number of exposures per design.

--preload-ahead <preload_ahead>

Preload the next design this many seconds before the exposure completes.

--add-hartmann

Take a Hartmann during the next goto-field (will not repeat Hartmanns).

--remove-hartmann

Removes a previously scheduled Hartmann.

bypass

Enable/disable bypasses.

Usage

hal bypass [OPTIONS] COMMAND [ARGS]...

disable

Disabless a series of bypasses

Usage

hal bypass disable [OPTIONS] [BYPASSES]...

Arguments

BYPASSES

Optional argument(s)

enable

Enables a series of bypasses

Usage

hal bypass enable [OPTIONS] [BYPASSES]...

Arguments

BYPASSES

Optional argument(s)

calibrations

Performs camera and telescope calibrations.

Usage

hal calibrations [OPTIONS] COMMAND [ARGS]...

apogee-dome-flat

Runs the APOGEE dome flat sequence.

Usage

hal calibrations apogee-dome-flat [OPTIONS]

Options

--list-stages

List the stages for this macro.

-s, --stages <stages>

Comma-separated list of stages to execute.

expose

Take science exposures.

Usage

hal expose [OPTIONS]

Options

--list-stages

List the stages for this macro.

-s, --stages <stages>

Comma-separated list of stages to execute.

--stop

Cancels an ongoing expose macro. Does not abort the ongoing exposures.

-m, --modify

Modify a running expose macro. The parameters of the previous expose command are NOT remembered; all flags must be passed again.

--pause

Pauses the execution of the macro. The current exposures will complete.

--resume

Resumes the execution of the macro.

-c, --count <count>

How many exposures to take. If exposing APOGEE and APOGEE exposure time is not explicitely defined, the last APOGEE exposure will finish as the BOSS readout begins.

--count-apogee <count_apogee>

How many APOGEE exposures to take. Overrides –count.

--count-boss <count_boss>

How many BOSS exposures to take. Overrides –count.

--apogee, -A, --no-apogee

Expose APOGEE.

--boss, -B, --no-boss

Expose BOSS.

-t, --exposure-time <exposure_time>

Exposure time, in seconds.

-b, --boss-exposure-time <boss_exposure_time>

BOSS exposure time in seconds.

-a, --apogee-exposure-time <apogee_exposure_time>

APOGEE exposure time in seconds. Disables readout matching.

-r, --reads <reads>

Number of APOGEE reads. Incompatible with –apogee-exposure-time.

-d, --disable-readout-matching

Does not try to match exposure times so that the last BOSS readout starts as APOGEE finishes exposing.

--pairs, -P, --no-pairs

Do dither pairs or single exposures. If –pairs, the exposure time for APOGEE refers to each dither and –counts refers to dither pairs.

--disable-dithering

If set, the dither position will not change between exposures.

--initial-apogee-dither <initial_apogee_dither>

Initial APOGEE dither position.

--with-fpi, --without-fpi

Open the FPI shutter.

get-command-model

Returns a dictionary representation of the command using unclick.

Usage

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

Arguments

COMMAND_NAME

Optional argument

get_schema

Returns the schema of the actor as a JSON schema.

Usage

hal get_schema [OPTIONS]

goto-field

Execute the go-to-field macro.

Usage

hal goto-field [OPTIONS]

Options

--list-stages

List the stages for this macro.

-s, --stages <stages>

Comma-separated list of stages to execute.

--auto

Selects the stages based on the latest design loaded.

--guider-time <guider_time>

Exposure time for guiding/acquisition.

--fixed-rot, --no-fixed-rot

Slews to a fixed rot position for the FVC loop. If –no-fixed-rot then –fixed-altaz is ignored.

--fixed-altaz, --no-fixed-altaz

Slews to a fixed alt/az position for the FVC loop.

--alt <alt>

The fixed altitude angle to which to slew for the FVC loop. Requires –fixed-altaz to take effect.

--az <az>

The fixed azimuth angle to which to slew for the FVC loop. Requires –fixed-altaz to take effect.

--rot <rot>

The fixed rotator angle to which to slew for the FVC loop.

--keep-offsets, --no-keep-offsets

Keep the guider offsets from the previous field.

--with-hartmann

Ensures the boss_hartmann stage is selected. Mostly relevant with –auto.

--stop

Stops the execution of the command.

gotoAll60

Send the telescope to (60, 60, 60).

Usage

hal gotoAll60 [OPTIONS]

Options

--stop

Stops the execution of the command.

gotoInstrumentChange

Send the telescope to (121, 90, 0).

Usage

hal gotoInstrumentChange [OPTIONS]

Options

--stop

Stops the execution of the command.

gotoStow

Send the telescope to (120, 30, 0).

Usage

hal gotoStow [OPTIONS]

Options

--stop

Stops the execution of the command.

gotoStow60

Send the telescope to (121, 60, 0).

Usage

hal gotoStow60 [OPTIONS]

Options

--stop

Stops the execution of the command.

help

Shows the help.

Usage

hal help [OPTIONS] [PARSER_COMMAND]

Arguments

PARSER_COMMAND

Optional argument

keyword

Prints human-readable information about a keyword.

Usage

hal keyword [OPTIONS] KEYWORD

Arguments

KEYWORD

Required argument

ping

Pings the actor.

Usage

hal ping [OPTIONS]

script

Tools to list and run scripts.

Usage

hal script [OPTIONS] COMMAND [ARGS]...

cancel

Cancels the execution of a script.

Usage

hal script cancel [OPTIONS] SCRIPT

Arguments

SCRIPT

Required argument

get-steps

Lists the steps in the script.

Usage

hal script get-steps [OPTIONS] SCRIPT

Arguments

SCRIPT

Required argument

list

Returns a list of available scripts.

Usage

hal script list [OPTIONS]

run

Runs a script.

Usage

hal script run [OPTIONS] SCRIPT

Arguments

SCRIPT

Required argument

running

Returns a list of running scripts.

Usage

hal script running [OPTIONS]

status

Outputs the status of the system.

Usage

hal status [OPTIONS]

Options

--full

Outputs additional information.

test

Runs the test macro.

Usage

hal test [OPTIONS]

Options

--list-stages

List the stages for this macro.

-s, --stages <stages>

Comma-separated list of stages to execute.

version

Reports the version.

Usage

hal version [OPTIONS]