Usage
roverctl is a CLI with various (nested) options. To view all available commands, run:
roverctl help
To generate autocompletion for your shell, run:
roverctl completion
Specify a Rover
Many commands require a Rover to be specified either through a Rover id (the index between 1-20 that you find on the Rover) or a host (to override the default IP address used to connect). You can also specify a Roverd username and password if you want to override the default username and password used. Examples include:
# Open roverctl-web for Rover 12
roverctl --rover 12
# Open roverctl-web for a Rover at 192.168.0.112
roverctl --host 192.168.0.112
# Open roverctl-web for Rover 12 with a custom username and password
roverctl -r 12 --username admin --password welcome123
Emergency Reset a Rover
If you lost control of a Rover you can stop the current pipeline and reset the motors and servo to a safe state using the emergency command.
Available shorthands are roverctl e and roverctl reset.
Example Usage
# Reset Rover 12
roverctl emergency -r 12
# Reset a Rover at 192.168.0.112
roverctl emergency --host 192.168.0.112
Calibrate a Rover
To correct for hardware error in the servo (noticeable when steering), you can use the calibrate command.
Every time you install a new actuator service, you will need to recalibrate it.
Example Usage
# Calibrate Rover 12
roverctl calibrate -r 12
# Calibrate a Rover at 192.168.0.112
roverctl calibrate --host 192.168.0.112
Open roverctl-web
To open the roverctl-web interface, you can just run roverctl followed by the Rover you want to connect to. Docker needs to be installed.
Example Usage
# Open roverctl-web for Rover 12
roverctl --rover 12
# Open roverctl-web for a Rover at 192.168.0.112
roverctl --host 192.168.0.112
# Open roverctl-web for Rover 12 with a custom username and password
roverctl -r 12 --username admin --password welcome123
View Build Info
To view information about your roverctl and/or roverd installation, you can use the roverctl info command. When no Rover is specified, roverd-specific information will not be fetched.
Example Usage
# View info about roverctl
roverctl info
# View info about Rover 12
roverctl info -r 12
# View info about a Rover at 192.168.0.112
roverctl info --host 192.168.0.112
Initialize a Service
To create a new service in your current working directory (a new subfolder will be created), you can use the roverctl service init command followed by the language you want to create your service in. You will need to specify a valid --name and --source for your service.
Example Usage
# See which languages are available
roverctl service init
# Initialize a go service called "my-distance-sensor" at "github.com/ielaajezdev/my-distance-sensor"
roverctl service init go --name my-distance-sensor --source github.com/ielaajezdev/my-distance-sensor
Upload a Service
Service directories can be uploaded to the Rover using the roverctl upload command. You can specify a Rover as shown above. You can upload one or multiple directories simultaneously and enable a file watcher to continuously sync your local changes to the Rover. You can find more information about the installation directory here.
Example Usage
# Upload your current working directory (.) to Rover 12
roverctl upload . -r 12
# Upload your current working directory (.) to Rover 12 and keep watching for changes
roverctl upload . -r 12 --watch
# Upload multiple directories to Rover 12
roverctl upload /dir1 /dir2 -r 12
# Upload multiple direcotires to a Rover at 192.168.0.112
roverctl upload /dir1 /dir2 --host 192.168.0.112
Describe a Service
After uploading to the Rover, you can query its status using the service info command using its fully qualified name.
Example Usage
# View info about the imaging service by vu-ase, version 1.2.3 installed on Rover 12
roverctl service info vu-ase imaging 1.2.3 -r 12
# View info about the imaging service by vu-ase, version 1.2.3 installed on the Rover at 192.168.0.112
roverctl service info vu-ase imaging 1.2.3 --host 192.168.0.112
Build a Service
After uploading to the Rover, you can use service build to run the build command specified in its service.yaml by using its fully qualified name. If a build fails, you will be presented the build logs (STDERR and STDOUT). More information on the build-time environment can be found here.
Example Usage
# Build the imaging service by vu-ase, version 1.2.3 installed on Rover 12
roverctl service build vu-ase imaging 1.2.3 -r 12
# Build the imaging service by vu-ase, version 1.2.3 installed on the Rover at 192.168.0.112
roverctl service build vu-ase imaging 1.2.3 --host 192.168.0.112
Delete a Service
Installed services can be deleted from the Rover by using the service delete command and the service's fully qualified name.
Example Usage
# Delete the imaging service by vu-ase, version 1.2.3 installed on Rover 12
roverctl service delete vu-ase imaging 1.2.3 -r 12
# Delete the imaging service by vu-ase, version 1.2.3 installed on the Rover at 192.168.0.112
roverctl service delete vu-ase imaging 1.2.3 --host 192.168.0.112
Install a Service From URL
Instead of uploading a service to the Rover, you can install any service by specifying a URL to a valid service directory published as ZIP file. The Rover must be connected to the Internet to succeed.
Example Usage
# Install a service from github onto Rover 12
roverctl service install https://github.com/VU-ASE/imaging/releases/download/v1.2.2/imaging.zip -r 12
# Install a service from github onto the Rover at 192.168.0.112
roverctl service install https://github.com/VU-ASE/imaging/releases/download/v1.2.2/imaging.zip --host 192.168.0.112
View Pipeline
To view the current enabled pipeline on the Rover, you can use the roverctl pipeline command. You can specify a Rover as shown above.
Example Usage
# View the pipeline of Rover 12
roverctl pipeline -r 12
# View the pipeline of a Rover at 192.168.0.112
roverctl pipeline --host 192.168.0.112
Start or Stop Pipeline
To start or stop the current enabled pipeline on the Rover, you can use the roverctl pipeline [start/stop] command. You can specify a Rover as shown above.
Example Usage
# Start the pipeline of Rover 12
roverctl pipeline start -r 12
# Start the pipeline of a Rover at 192.168.0.112
roverctl pipeline start --host 192.168.0.112
# Stop the pipeline of Rover 12
roverctl pipeline stop -r 12
# Stop the pipeline of a Rover at 192.168.0.112
roverctl pipeline stop --host 192.168.0.112
View Services
To view the currently installed services on the Rover, you can use the roverctl services command. You can specify a Rover as shown above.
Example Usage
# View the services installed on Rover 12
roverctl services -r 12
# View the servies installed on a Rover at 192.168.0.112
roverctl services --host 192.168.0.112
View a Specific Service
To view information about a specific service installed on the Rover, you can use the roverctl services info command. You can specify a Rover as shown above.
Example Usage
# View service information about the "controller" service by "vu-ase" version 1.0.0 installed on Rover 12
roverctl services info vu-ase controller 1.0.0 -r 12
# View service information about the "controller" service by "vu-ase" version 1.0.0 installed on a Rover at 192.168.0.112
roverctl services info vu-ase controller 1.0.0 --host 192.168.0.112
Enable or Disable Services
To enable or disable services in the pipeline on the Rover, you can use the roverctl pipeline [enable/disable] command. You can specify a Rover as shown above. Services to be enabled must be fully qualified (i.e. by author, name and version). When disabling, only the author and name need to be specified.
Example Usage
# Enable the vu-ase imaging service (version 1.2.3) in the pipeline of Rover 12
roverctl pipeline enable vu-ase imaging 1.2.3 -r 12
# Enable the vu-ase imaging service (version 1.2.3) in the pipeline of a Rover at 192.168.0.112
roverctl pipeline enable vu-ase imaging 1.2.3 --host 192.168.0.112
# Disable the vu-ase imaging service in the pipeline of Rover 12
roverctl pipeline disable vu-ase imaging -r 12
# Disable the vu-ase imaging service in the pipeline of a Rover at 192.168.0.112
roverctl pipeline disable vu-ase imaging --host 192.168.0.112
View Service Logs
To view logs of current and previous runs of a specific service, you can use the roverctl logs command. You can specify a Rover as shown above. Services must be fully qualified (i.e. by author, name and version).
Example Usage
# View logs for the the vu-ase imaging service (version 1.2.3) of Rover 12
roverctl logs vu-ase imaging 1.2.3 -r 12
# View logs for the vu-ase imaging service (version 1.2.3) of a Rover at 192.168.0.112
roverctl logs vu-ase imaging 1.2.3 --host 192.168.0.112
Empty a Pipeline
To reset the active pipeline, you can use the pipeline reset command. This is not the same as an emergency reset.
Example Usage
# Reset the pipeline of Rover 12
roverctl pipeline reset -r 12
# Reset the pipeline of a Rover at 192.168.0.112
roverctl pipeline reset --host 192.168.0.112
Shutdown a Rover
To safely shut down a Rover, you can use the shutdown command.
Example Usage
# Shutdown Rover 12
roverctl shutdown -r 12
# Shutdown a Rover at 192.168.0.112
roverctl shutdown --host 192.168.0.112