Actor Commands¶

The lvmecp replies to the follwing commands.

lvmecp¶

lvmecp [OPTIONS] COMMAND [ARGS]...

dome¶

Commands the dome.

lvmecp dome [OPTIONS] COMMAND [ARGS]...

close¶

Closes the dome.

lvmecp dome close [OPTIONS]

Options

--force¶: Force dome closing.

--overcurrent¶: Close the dome using the overcurrent mode.

open¶

Opens the dome.

lvmecp dome open [OPTIONS]

Options

--force¶: Force dome opening.

reset¶

Resets dome error state and anti-flap count.

lvmecp dome reset [OPTIONS]

status¶

Returns the status of the dome.

lvmecp dome status [OPTIONS]

stop¶

Stops the dome if it’s moving.

lvmecp dome stop [OPTIONS]

emergency-stop¶

Trigger and emergency stop.

lvmecp emergency-stop [OPTIONS]

engineering-mode¶

Enable/disable the engineering mode.

lvmecp engineering-mode [OPTIONS] COMMAND [ARGS]...

disable¶

Disables the engineering mode.

lvmecp engineering-mode disable [OPTIONS]

enable¶

Enables the engineering mode.

lvmecp engineering-mode enable [OPTIONS]

Options

-t, --timeout <timeout>¶: Timeout for the engineering mode. If not passed, the default timeout is used.

--hardware-override¶: Sets the hardware override flag.

--software-override¶: Sets the software override flag.

reset-e-stops¶

Resets the e-stop relays.

lvmecp engineering-mode reset-e-stops [OPTIONS]

status¶

Returns the status of the engineering mode.

lvmecp engineering-mode status [OPTIONS]

get-command-model¶

Returns a dictionary representation of the command using unclick.

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

Arguments

COMMAND_NAME¶: Optional argument

get_schema¶

Returns the schema of the actor as a JSON schema.

lvmecp get_schema [OPTIONS]

heartbeat¶

Sets the heartbeat variable on the PLC.

lvmecp heartbeat [OPTIONS]

help¶

Shows the help.

lvmecp help [OPTIONS] [PARSER_COMMAND]

Arguments

PARSER_COMMAND¶: Optional argument

keyword¶

Prints human-readable information about a keyword.

lvmecp keyword [OPTIONS] KEYWORD

Arguments

KEYWORD¶: Required argument

lights¶

Manages the enclosure lights.

lvmecp lights [OPTIONS] [[on|off|toggle|status]] [LIGHT]

Arguments

ACTION¶: Optional argument

LIGHT¶: Optional argument

modbus¶

Low-level access to the PLC Modbus variables.

lvmecp modbus [OPTIONS] COMMAND [ARGS]...

read¶

Reads a Modbus register.

lvmecp modbus read [OPTIONS] ADDRESS|NAME

Options

--register-type <register_type>¶

The type of register to read. Required if an address is passed.

Options:: coil | holding_register

--allow-unknown¶: Allow unknown registers. Requires specifying an address.

Arguments

ADDRESS|NAME¶: Required argument

write¶

Writes a value to a Modbus register.

lvmecp modbus write [OPTIONS] ADDRESS|NAME VALUE

Options

--register-type <register_type>¶

The type of register to read. Required if an address is passed.

Options:: coil | holding_register

--allow-unknown¶: Allow unknown registers. Requires specifying an address.

Arguments

ADDRESS|NAME¶: Required argument

VALUE¶: Required argument

ping¶

Pings the actor.

lvmecp ping [OPTIONS]

status¶

Returns the enclosure status.

lvmecp status [OPTIONS]

Options

--no-registers¶: Does not output registers.

--no-cache¶: Ignores the internal cache.

version¶

Reports the version.

lvmecp version [OPTIONS]