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

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

debug¶

Debug and engineering tools.

jaeger-actor debug [OPTIONS] COMMAND [ARGS]...

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

led¶

Sets the level of the FVC LED.

jaeger-actor fvc led [OPTIONS] LEVEL

Arguments

LEVEL¶: Required argument

nuc¶

Turns NUC on/off.

jaeger-actor fvc nuc [OPTIONS] {on|off}

Arguments

MODE¶: Required argument

status¶

Reports the status of the FVC.

jaeger-actor fvc status [OPTIONS]

get_schema¶

Returns the schema of the actor as a JSON schema.

jaeger-actor get_schema [OPTIONS]

goto¶

Sends positioners to a given (alpha, beta) position.

jaeger-actor goto [OPTIONS] [POSITIONER_IDS]... ALPHA BETA

Options

-r, --relative¶: Whether this is a relative move

-s, --speed <speed>¶: The speed of 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.

Arguments

POSITIONER_IDS¶: Optional argument(s)

ALPHA¶: Required argument

BETA¶: Required argument

hall¶

Turns the hall sensor on/off.

jaeger-actor hall [OPTIONS] COMMAND [ARGS]...

off¶

Turns the hall sensor off.

jaeger-actor hall off [OPTIONS] [POSITIONER_ID]...

Arguments

POSITIONER_ID¶: Optional argument(s)

on¶

Turns the hall sensor on.

jaeger-actor hall on [OPTIONS] [POSITIONER_ID]...

Arguments

POSITIONER_ID¶: Optional argument(s)

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

info¶

Shows information about the IEB layout in a human-readable format.

jaeger-actor ieb info [OPTIONS]

Options

-v, --verbose¶: Shows extra information.

power¶

Runs the power on/off sequences.

jaeger-actor ieb power [OPTIONS] COMMAND [ARGS]...

off¶

Powers off all the FPS IEB components.

jaeger-actor ieb power off [OPTIONS]

Options

--nucs¶: Also power down NUCs

on¶

Powers on all the FPS IEB components.

jaeger-actor ieb power on [OPTIONS]

status¶

Outputs the status of the devices.

jaeger-actor ieb status [OPTIONS]

switch¶

Switches the status of an on/off device.

jaeger-actor ieb switch [OPTIONS] [DEVICES]...

Options

--on, --off¶: the desired state of the device. If not passed, switches the current state.

--cycle¶: power cycles a relay. The final status is on.

--delay <delay>¶: When powering multiple devices, the delay to wait between them.

Arguments

DEVICES¶: Optional argument(s)

info¶

Reports information about the system.

jaeger-actor info [OPTIONS]

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

off¶

Turns the LED off.

jaeger-actor led off [OPTIONS] [POSITIONER_ID]...

Arguments

POSITIONER_ID¶: Optional argument(s)

on¶

Turns the LED on.

jaeger-actor led on [OPTIONS] [POSITIONER_ID]...

Arguments

POSITIONER_ID¶: Optional argument(s)

ping¶

Pings the actor.

jaeger-actor ping [OPTIONS]

pollers¶

Handle the positioner pollers.

jaeger-actor pollers [OPTIONS] COMMAND [ARGS]...

list¶

Lists available pollers.

jaeger-actor pollers list [OPTIONS]

start¶

Start pollers.

jaeger-actor pollers start [OPTIONS] [POLLER]

Arguments

POLLER¶: Optional argument

stop¶

Stop pollers.

jaeger-actor pollers stop [OPTIONS] [POLLER]

Arguments

POLLER¶: Optional argument

reload¶

Reinitialise the FPS.

jaeger-actor reload [OPTIONS]

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] [POSITIONER_IDS]...

Options

-f, --full¶: outputs more statuses.

Arguments

POSITIONER_IDS¶: Optional argument(s)

stop¶

Stops the positioners and clear flags.

jaeger-actor stop [OPTIONS]

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

unlock¶

Unlocks the FPS.

jaeger-actor unlock [OPTIONS]

version¶

Reports the version.

jaeger-actor version [OPTIONS]

Schema¶

type	object
properties
config_file	type	string
low_temperature	type	integer
	enum	0, 1, 2
temperature	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
humidity	Relative humidity measurements
	type	array
	items
		RH1
		type	number
		RH3
		type	number
voltage	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
flow	Coolant flow measurements
	type	array
	items
		FLOW1
		type	number
		FLOW2
		type	number
pressure	Coolant pressure measurements
	type	array
	items
		PRESSURE1
		type	number
		PRESSURE2
		type	number
fbi_led	Integration spheres LED power
	type	array
	items
		LED1
		type	number
		multipleOf	0.1
		LED2
		type	number
		multipleOf	0.1
power_sextant	Power supply relays
	type	array
	items
		PS1
		type	boolean
		PS2
		type	boolean
		PS3
		type	boolean
		PS4
		type	boolean
		PS5
		type	boolean
		PS6
		type	boolean
power_can	CANNet module relays
	type	array
	items
		CM1
		type	boolean
		CM2
		type	boolean
		CM3
		type	boolean
		CM4
		type	boolean
		CM5
		type	boolean
		CM6
		type	boolean
power_sync	SYNC line status
	type	array
	items
		SYNC
		type	boolean
power_gfa	GFA power relays
	type	array
	items
		GFA1
		type	boolean
		GFA2
		type	boolean
		GFA3
		type	boolean
		GFA4
		type	boolean
		GFA5
		type	boolean
		GFA6
		type	boolean
power_nuc	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	FVC temperature measurements
	type	array
	items
		RTD1
		type	number
		RTD2
		type	number
		RTD3
		type	number
fvc_power_nuc	FVC NUC power
	type	array
	items
		NUC
		type	boolean
fvc_power_camera	FVC camera power
	type	array
	items
		FVC
		type	boolean
fvc_led	FVC LED power
	type	array
	items
		LED1
		type	number
move_time	type	number
locked	type	boolean
n_positioners	type	integer
status	type	array
	items
		positioner_id
		type	integer
		alpha
		type	number
		beta
		type	number
		bits
		type	integer
		initialised
		type	boolean
		bootloader
		type	boolean
		firmware
		type	string
		interface
		type	integer
		bus
		type	integer
		n_trajectories
		oneOf	type	integer
raw	type	array
	items
		command_id
		type	integer
		uid
		type	integer
		response_code
		type	integer
		data
		type	string
additionalProperties	False