Basic Usage¶
Here we'll describe basic usage of the Automator. You should get a feeling for how to start the application and access its built-in help.
Note that we will be assuming that you run on a Linux machine and want our simulated headless mode, so these examples all use surfmeter-automator-headless as an executable. If you are running on a different OS or have different requirements, please first read the Headless vs. GUI section.
Getting Version Information¶
Simply run:
Headless vs. GUI
Why do we call it headless? We have different modes of operation when you have a display connected to the device.
You can check out the Headless vs. GUI section to see the differences between the modes of operation.
This should show you the version of the Automator.
Showing the Available Commands¶
To get a list of all available commands, run:
This should print something similar to the following:
surfmeter-automator <command>
Commands:
...
Options:
...
Run surfmeter-automator [command] --help for more info on a command, e.g. 'surfmeter-automator startStudy --help'.
Copyright AVEQ GmbH 2023
Commands and Options
Surfmeter has lots of different commands and options, and we will cover them in the commands and options reference. If you want to look up every detail, you can head to this section. Just remember that you can always refer to the list of commands in case of an error when calling Automator.
Surfmeter Automator offers flexible ways to initiate measurements. While detailed configurations allow for complex study definitions (see Running Studies and Changing the Configuration), you can also quickly run an ad-hoc test simply by providing a URL. This is a great way to perform a quick measurement without any prior setup of study definitions. For more details on running studies, including the ad-hoc URL method and using predefined study IDs, see the Running Studies section.
To really get you started though, first we'll have to register the software with the server.