Commands

The lvmnps actor replies to the follwing commands.

lvmnps

lvmnps [OPTIONS] COMMAND [ARGS]...

all-off

Turns all outlets off.

lvmnps all-off [OPTIONS]

cycle

Cycles an outlet or outlets.

OUTLETS can be a single outlet name or outlet ID, or a list of them that will be switched on as quickly as possible. An argument that can be casted into an integer will be considered an outlet ID.

lvmnps cycle [OPTIONS] [OUTLETS]...

Options

--delay <delay>

Delay between off an on in seconds

Arguments

OUTLETS

Optional argument(s)

get-command-model

Returns a dictionary representation of the command using unclick.

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

Arguments

COMMAND_NAME

Optional argument

get_schema

Returns the schema of the actor as a JSON schema.

lvmnps get_schema [OPTIONS]

help

Shows the help.

lvmnps help [OPTIONS] [PARSER_COMMAND]

Arguments

PARSER_COMMAND

Optional argument

keyword

Prints human-readable information about a keyword.

lvmnps keyword [OPTIONS] KEYWORD

Arguments

KEYWORD

Required argument

off

Turns an outlet or outlets off.

OUTLETS can be a single outlet name or outlet ID, or a list of them that will be switched on as quickly as possible. An argument that can be casted into an integer will be considered an outlet ID.

lvmnps off [OPTIONS] [OUTLETS]...

Arguments

OUTLETS

Optional argument(s)

on

Turns an outlet or outlets on.

OUTLETS can be a single outlet name or outlet ID, or a list of them that will be switched on as quickly as possible. An argument that can be casted into an integer will be considered an outlet ID.

lvmnps on [OPTIONS] [OUTLETS]...

Options

--off-after <off_after>

Turns the outlet off after N seconds.

Arguments

OUTLETS

Optional argument(s)

ping

Pings the actor.

lvmnps ping [OPTIONS]

refresh

Refreshes the internal list of outlets.

lvmnps refresh [OPTIONS]

Options

-q, --quiet

Does not output status after refreshing

scripts

Handles user scripts.

lvmnps scripts [OPTIONS] COMMAND [ARGS]...

list

Lists running scripts.

lvmnps scripts list [OPTIONS]

run

Runs a user script.

The first argument is expected to be the name of the script. Additional argument will be considered arguments to pass to the script function.

lvmnps scripts run [OPTIONS] [SCRIPT]...

Arguments

SCRIPT

Optional argument(s)

stop

Runs a user script.

If the thread number is not provided, stops all running scripts.

lvmnps scripts stop [OPTIONS] [THREAD]

Arguments

THREAD

Optional argument

status

Outputs the status of the network power switch.

If an OUTLET is passed, returns only the status of that outlet.

lvmnps status [OPTIONS] [OUTLET]

Arguments

OUTLET

Optional argument

version

Reports the version.

lvmnps version [OPTIONS]