Commands#
Command Line Interface#
fliswarm#
CLI for the fliswarm actor.
fliswarm [OPTIONS] COMMAND [ARGS]...
Options
- -c, --config <config>#
Path to an external configuration file.
- --nodes <nodes>#
Comma-separated nodes to connect.
actor#
Start/stop the actor as a daemon.
fliswarm actor [OPTIONS] COMMAND [ARGS]...
restart#
Restart the daemon.
fliswarm actor restart [OPTIONS]
start#
Start the daemon.
fliswarm actor start [OPTIONS]
Options
- --debug#
Do NOT detach and run in the background.
- --log-file <log_file>#
Redirects stdout and stderr to a file (rotates logs). Ignored if –debug.
- --pid_file <pid_file>#
PID file to keep track of the daemon execution.
status#
Report if the daemon is running.
fliswarm actor status [OPTIONS]
stop#
Stop the daemon.
fliswarm actor stop [OPTIONS]
Actor Commands#
fliswarm#
fliswarm [OPTIONS] COMMAND [ARGS]...
disable#
Disables one or multiple cameras/nodes.
fliswarm disable [OPTIONS] NODES
Options
- -a, --all#
Disable all nodes.
Arguments
- NODES#
Optional argument(s)
enable#
Enables one or multiple cameras.
fliswarm enable [OPTIONS] NODES
Options
- -a, --all#
Enable all nodes.
Arguments
- NODES#
Optional argument(s)
get_schema#
Returns the schema of the actor as a JSON schema.
fliswarm get_schema [OPTIONS]
help#
Shows the help.
fliswarm help [OPTIONS] [PARSER_COMMAND]
Arguments
- PARSER_COMMAND#
Optional argument
keyword#
Prints human-readable information about a keyword.
fliswarm keyword [OPTIONS] KEYWORD
Arguments
- KEYWORD#
Required argument
ping#
Pings the actor.
fliswarm ping [OPTIONS]
reboot#
Reboot the NUC computer(s).
fliswarm reboot [OPTIONS]
Options
- -n, --names <names>#
Comma-separated nodes to reconnect.
- -c, --category <category>#
Category of nodes to reconnect (gfa, fvc).
- -f, --hard#
Reboots the NUC by power cycling it.
reconnect#
Recreates volumes and restarts the Docker containers.
fliswarm reconnect [OPTIONS]
Options
- -n, --names <names>#
Comma-separated nodes to reconnect.
- -c, --category <category>#
Category of nodes to reconnect (gfa, fvc).
- -f, --force#
Stops and restarts services even if they are running.
simulate#
Simulate images being written to disk.
fliswarm simulate [OPTIONS] [GLOB]
Options
- --delay <delay>#
Delay between outputting images.
- --random#
Randomise images.
- --stop#
Stops the execution of the command.
Arguments
- GLOB#
Optional argument
status#
Outputs the status of the nodes and containers.
fliswarm status [OPTIONS]
talk#
Sends a command to selected or all cameras.
fliswarm talk [OPTIONS] [CAMERA_COMMAND]...
Options
- -n, --names <names>#
Comma-separated cameras to command.
- -c, --category <category>#
Category of cameras to talk to (gfa, fvc).
Arguments
- CAMERA_COMMAND#
Optional argument(s)
tron-reconnect#
Pings the actor.
fliswarm tron-reconnect [OPTIONS]
version#
Reports the version.
fliswarm version [OPTIONS]