Actor#
The jaeger actor provides a TCP/IP interface to the jaeger functionality. jaeger uses CLU to provide the actor framework. Most actor commands are thin wrappers around the functionality provided by the jaeger API.
The following commands are available in the jaeger actor.
jaeger-actor#
jaeger-actor [OPTIONS] COMMAND [ARGS]...
alerts#
Manages the alerts system.
jaeger-actor alerts [OPTIONS] COMMAND [ARGS]...
reset#
Clears all the alerts. Needed after certain alerts have been raised.
jaeger-actor alerts reset [OPTIONS]
chiller#
Shows the status and controlls the chiller.
jaeger-actor chiller [OPTIONS] COMMAND [ARGS]...
configuration#
Allows to load a configuration, ingest it to the database, and execute it.
jaeger-actor configuration [OPTIONS] COMMAND [ARGS]...
dither#
Dither a loaded configuration.
jaeger-actor configuration dither [OPTIONS] RADIUS
Arguments
- RADIUS#
Required argument
execute#
Executes a configuration trajectory (folded to targets).
jaeger-actor configuration execute [OPTIONS]
load#
Creates and ingests a configuration from a design in the database.
jaeger-actor configuration load [OPTIONS] [DESIGNID]
Options
- --reload#
If the design is currently loaded, creates a new configuration.
- --replace#
Replace an existing entry.
- --generate-paths, --no-generate-paths#
Generates and stores the to and from destination paths.
- --epoch-delay <epoch_delay>#
A delay in seconds for the epoch for which the configuration is calculated.
- --from-positions#
Loads a configuration from the current robot positions.
- --from-preloaded#
Finishes loading a preloaded configuration.
- --ingest, --no-ingest#
Whether to ingest the configuration into the DB.
- --write-summary, --no-write-summary#
Whether to write the summary file for the configuration. Ignored if –no-ingest.
- --execute, --no-execute#
Send and start the from_destination trajectory.
- --reissue#
Only reissue the configuration_loaded keyword.
- --scale <scale>#
Focal plane scale factor. If not passes, uses coordio default.
- --no-clone#
If the new design has the same target set as the currently loaded one, does not clone the configuration and instead loads the new design.
- --stop#
Stops the execution of the command.
Arguments
- DESIGNID#
Optional argument
preload#
Preloads a design.
Preloading a design works similar to loading it, but no files are generated, no database entry is created, no configuration_loaded keyword is output, and the new configuration is stored separately. To make the preloaded configuration active either pass the –make-active flag or run jaeger configuration load –from-preloaded.
jaeger-actor configuration preload [OPTIONS] [DESIGNID]
Options
- --epoch-delay <epoch_delay>#
A delay in seconds for the epoch for which the configuration is calculated.
- --scale <scale>#
Focal plane scale factor. If not passes, uses coordio default.
- --no-clone#
If the new design has the same target set as the currently loaded one, does not clone the configuration and instead loads the new design.
- --make-active#
Loads the configuration after preloading.
- --clear#
Clears the preloaded configuration.
- --stop#
Stops the execution of the command.
Arguments
- DESIGNID#
Optional argument
random#
Executes a random, valid configuration.
jaeger-actor configuration random [OPTIONS] [SEED]
Options
- --danger#
Use full range of alpha and beta.
- --uniform <uniform>#
Comma-separated alpha and beta ranges.
- --collision-buffer <collision_buffer>#
Custom collision buffer
- --send-trajectory, --no-send-trajectory#
Send the trajectory to the FPS.
Arguments
- SEED#
Optional argument
current#
Sets the current of the positioner.
jaeger-actor current [OPTIONS] [POSITIONER_ID]... ALPHA BETA
Options
- -a, --all#
applies to all connected positioners.
Arguments
- POSITIONER_ID#
Optional argument(s)
- ALPHA#
Required argument
- BETA#
Required argument
disable#
Disables a positioner
jaeger-actor disable [OPTIONS] POSITIONER_ID
Arguments
- POSITIONER_ID#
Required argument
enable#
Enables a positioner
jaeger-actor enable [OPTIONS] POSITIONER_ID
Arguments
- POSITIONER_ID#
Required argument
explode#
Explodes the FPS.
jaeger-actor explode [OPTIONS] EXPLODE_DEG
Options
- --one <one>#
Only explode this positioner.
Arguments
- EXPLODE_DEG#
Required argument
fvc#
Commands to command the FVC.
jaeger-actor fvc [OPTIONS] COMMAND [ARGS]...
camera#
Turns camera on/off.
jaeger-actor fvc camera [OPTIONS] {on|off}
Arguments
- MODE#
Required argument
expose#
Takes an exposure with the FVC.
jaeger-actor fvc expose [OPTIONS] [EXPOSURE_TIME]
Arguments
- EXPOSURE_TIME#
Optional argument
led#
Sets the level of the FVC LED.
jaeger-actor fvc led [OPTIONS] LEVEL
Arguments
- LEVEL#
Required argument
loop#
Executes the FVC correction loop.
This routine will turn the FBI LEDs on, take FVC exposures, process them, calculate the offset correction and applies them. Loops until the desided convergence is achieved.
jaeger-actor fvc loop [OPTIONS]
Options
- --exposure-time <exposure_time>#
Exposure time.
- --fbi-level <fbi_level>#
FBI LED levels.
- --one#
Only runs one FVC correction iteration.
- --max-iterations <max_iterations>#
Maximum number of iterations.
- --stack <stack>#
Number of FVC image to stack.
- --plot, --no-plot#
Generate and save plots.
- --apply, --no-apply#
Apply corrections.
- -m, --max-correction <max_correction>#
Maximum correction allowed, in degrees.
- --target-90-percentile <target_90_percentile>#
90% percentile target, in microns, at which to stop iterating.
- -k <k>#
Proportional term of the correction.
- --use-winpos, --no-use-winpos#
Use windowed positions during centroid extraction.
- --use-invkin, --no-use-invkin#
Use new inverse kinnematics.
- --no-write-summary#
Does not try to write a confSummaryF file.
- --stop#
Stops the execution of the command.
goto#
Sends positioners to a given (alpha, beta) position.
jaeger-actor goto [OPTIONS] [POSITIONER_IDS]... [ALPHA] [BETA]
Options
- -l, --from-file <from_file>#
Loads the trajectory from a JSON trajectory file. Unless –go-cowboy is used only the end points of the trajectories for each positioner are used.
- -r, --relative#
Whether this is a relative move
- -s, --speed <speed>#
The speed for both alpha and beta arms, in RPS on the input.
- -a, --all#
Applies to all valid positioners.
- -f, --force#
Forces a move to happen.
- --use-sync, -no-use-sync, -S#
Whether to use the SYNC line to start the trajectory.
- --go-cowboy#
If set, does not use kaiju-validated trajectories.
Arguments
- POSITIONER_IDS#
Optional argument(s)
- ALPHA#
Optional argument
- BETA#
Optional argument
hall#
Turns the hall sensor on/off.
jaeger-actor hall [OPTIONS] COMMAND [ARGS]...
help#
Shows the help.
jaeger-actor help [OPTIONS] [PARSER_COMMAND]
Arguments
- PARSER_COMMAND#
Optional argument
ieb#
Manages the IEB.
jaeger-actor ieb [OPTIONS] COMMAND [ARGS]...
fbi#
Control the power output (0-100%) of the fibre back illuminator (FBI).
jaeger-actor ieb fbi [OPTIONS] DEVICES VALUE
Arguments
- DEVICES#
Optional argument(s)
- VALUE#
Required argument
initialise#
Initialises positioners.
jaeger-actor initialise [OPTIONS] [POSITIONER_ID]...
Options
- --datums#
If set, initialises the datums.
Arguments
- POSITIONER_ID#
Optional argument(s)
keyword#
Prints human-readable information about a keyword.
jaeger-actor keyword [OPTIONS] KEYWORD
Arguments
- KEYWORD#
Required argument
led#
Turns the positioner LED on/off.
jaeger-actor led [OPTIONS] COMMAND [ARGS]...
pollers#
Handle the positioner pollers.
jaeger-actor pollers [OPTIONS] COMMAND [ARGS]...
power#
Runs the power on/off sequences and powers individual devices.
jaeger-actor power [OPTIONS] COMMAND [ARGS]...
off#
Powers off all the FPS IEB components or a specific device.
jaeger-actor power off [OPTIONS] [DEVICES]...
Options
- --nucs#
Also power down NUCs
- --delay <delay>#
When powering multiple devices, the delay to wait between them.
Arguments
- DEVICES#
Optional argument(s)
on#
Powers on all the FPS IEB components or a specific device.
jaeger-actor power on [OPTIONS] [DEVICES]...
Options
- --gfas#
Power on the GFAs.
- --delay <delay>#
When powering multiple devices, the delay to wait between them.
- --force#
Forces a device to turn on/off even if disabled.
Arguments
- DEVICES#
Optional argument(s)
set-collision-margin#
Change the collision margin. The collision margin must be -30 to 30 degrees.
jaeger-actor set-collision-margin [OPTIONS] MARGIN
Options
- -p, --positioners <positioners>#
Comma-separated positioners to which to apply the margin. If not set, applies to all the positioners.
Arguments
- MARGIN#
Required argument
snapshot#
Takes a snapshot image.
jaeger-actor snapshot [OPTIONS] [PATH]
Arguments
- PATH#
Optional argument
speed#
Sets the (alpha, beta)
speed in RPM on the input.
jaeger-actor speed [OPTIONS] [POSITIONER_ID]... ALPHA BETA
Options
- -a, --all#
applies to all valid positioners.
Arguments
- POSITIONER_ID#
Optional argument(s)
- ALPHA#
Required argument
- BETA#
Required argument
status#
Reports the position and status bit of a list of positioners.
jaeger-actor status [OPTIONS] [POSITIONERS]...
Arguments
- POSITIONERS#
Optional argument(s)
talk#
Send a direct command to the CAN network and show the replies.
jaeger-actor talk [OPTIONS] COMMAND_ID POSITIONER_ID [PARAMS]...
Arguments
- COMMAND_ID#
Required argument
- POSITIONER_ID#
Required argument
- PARAMS#
Optional argument(s)
trajectory#
Sends a trajectory from a file.
jaeger-actor trajectory [OPTIONS] PATH
Arguments
- PATH#
Required argument
Schema#
type |
object |
|||
properties |
||||
|
type |
string |
||
|
Temperature measurements |
|||
type |
array |
|||
items |
||||
T1 |
||||
type |
number |
|||
T3 |
||||
type |
number |
|||
RTD1 |
||||
type |
number |
|||
RTD2 |
||||
type |
number |
|||
RTD3 |
||||
type |
number |
|||
RTD4 |
||||
type |
number |
|||
RTD6 |
||||
type |
number |
|||
RTD7 |
||||
type |
number |
|||
RTD8 |
||||
type |
number |
|||
RTD9 |
||||
type |
number |
|||
RTD10 |
||||
type |
number |
|||
RTD11 |
||||
type |
number |
|||
RTD12 |
||||
type |
number |
|||
|
Relative humidity measurements |
|||
type |
array |
|||
items |
||||
RH1 |
||||
type |
number |
|||
RH3 |
||||
type |
number |
|||
|
Power supply voltage measurements |
|||
type |
array |
|||
items |
||||
PV24_1 |
||||
type |
number |
|||
PV24_2 |
||||
type |
number |
|||
PV24_3 |
||||
type |
number |
|||
PV24_4 |
||||
type |
number |
|||
PV24_5 |
||||
type |
number |
|||
PV24_6 |
||||
type |
number |
|||
|
Coolant flow measurements |
|||
type |
array |
|||
items |
||||
FLOW1 |
||||
type |
number |
|||
FLOW2 |
||||
type |
number |
|||
|
Coolant pressure measurements |
|||
type |
array |
|||
items |
||||
PRESSURE1 |
||||
type |
number |
|||
PRESSURE2 |
||||
type |
number |
|||
|
Integration spheres LED power |
|||
type |
array |
|||
items |
||||
LED1 |
||||
type |
number |
|||
LED2 |
||||
type |
number |
|||
LED3 |
||||
type |
number |
|||
LED4 |
||||
type |
number |
|||
|
Power supply relays |
|||
type |
array |
|||
items |
||||
PS1 |
||||
type |
boolean |
|||
PS2 |
||||
type |
boolean |
|||
PS3 |
||||
type |
boolean |
|||
PS4 |
||||
type |
boolean |
|||
PS5 |
||||
type |
boolean |
|||
PS6 |
||||
type |
boolean |
|||
|
CANNet module relays |
|||
type |
array |
|||
items |
||||
CM1 |
||||
type |
boolean |
|||
CM2 |
||||
type |
boolean |
|||
CM3 |
||||
type |
boolean |
|||
CM4 |
||||
type |
boolean |
|||
CM5 |
||||
type |
boolean |
|||
CM6 |
||||
type |
boolean |
|||
|
SYNC line status |
|||
type |
array |
|||
items |
||||
SYNC |
||||
type |
boolean |
|||
|
GFA power relays |
|||
type |
array |
|||
items |
||||
GFA1 |
||||
type |
boolean |
|||
GFA2 |
||||
type |
boolean |
|||
GFA3 |
||||
type |
boolean |
|||
GFA4 |
||||
type |
boolean |
|||
GFA5 |
||||
type |
boolean |
|||
GFA6 |
||||
type |
boolean |
|||
|
GFA NUC relays |
|||
type |
array |
|||
items |
||||
NUC1 |
||||
type |
boolean |
|||
NUC2 |
||||
type |
boolean |
|||
NUC3 |
||||
type |
boolean |
|||
NUC4 |
||||
type |
boolean |
|||
NUC5 |
||||
type |
boolean |
|||
NUC6 |
||||
type |
boolean |
|||
|
FVC temperature measurements |
|||
type |
array |
|||
items |
||||
RTD1 |
||||
type |
number |
|||
RTD2 |
||||
type |
number |
|||
RTD3 |
||||
type |
number |
|||
|
FVC NUC power |
|||
type |
array |
|||
items |
||||
NUC |
||||
type |
boolean |
|||
|
FVC camera power |
|||
type |
array |
|||
items |
||||
FVC |
||||
type |
boolean |
|||
|
FVC LED power |
|||
type |
array |
|||
items |
||||
LED1 |
||||
type |
number |
|||
|
type |
number |
||
|
type |
number |
||
|
type |
boolean |
||
|
type |
array |
||
items |
type |
number |
||
|
type |
boolean |
||
|
type |
integer |
||
|
type |
array |
||
items |
||||
positioner_id |
||||
type |
integer |
|||
alpha |
||||
type |
number |
|||
beta |
||||
type |
number |
|||
bits |
||||
type |
string |
|||
initialised |
||||
type |
boolean |
|||
disabled |
||||
type |
boolean |
|||
offline |
||||
type |
boolean |
|||
bootloader |
||||
type |
boolean |
|||
firmware |
||||
type |
string |
|||
interface |
||||
type |
integer |
|||
bus |
||||
type |
integer |
|||
n_trajectories |
||||
oneOf |
type |
integer |
||
|
type |
string |
||
|
type |
array |
||
items |
||||
command_id |
||||
type |
integer |
|||
uid |
||||
type |
integer |
|||
response_code |
||||
type |
integer |
|||
data |
||||
type |
string |
|||
|
type |
array |
||
items |
||||
configuration_id |
||||
type |
integer |
|||
design_id |
||||
type |
integer |
|||
field_id |
||||
type |
integer |
|||
ra_boresight |
||||
type |
number |
|||
dec_boresight |
||||
type |
number |
|||
position_angle |
||||
type |
number |
|||
alt_boresight |
||||
type |
number |
|||
az_boresight |
||||
type |
number |
|||
summary_file |
||||
type |
string |
|||
cloned |
||||
type |
boolean |
|||
|
type |
integer |
||
|
type |
string |
||
|
type |
number |
||
|
type |
number |
||
|
type |
number |
||
|
type |
number |
||
|
type |
string |
||
|
type |
string |
||
|
type |
string |
||
|
type |
string |
||
|
type |
string |
||
|
type |
number |
||
|
type |
number |
||
|
type |
number |
||
|
type |
number |
||
|
type |
string |
||
|
type |
integer |
||
|
type |
integer |
||
|
type |
integer |
||
|
type |
integer |
||
|
type |
integer |
||
|
type |
integer |
||
|
type |
integer |
||
|
type |
integer |
||
|
type |
integer |
||
|
type |
integer |
||
|
type |
integer |
||
additionalProperties |
False |