Using qosst-alice

This section will explain how to start using qosst-alice. This procedure is also explained in the QOSST tutorial

Creating the configuration file and filling it

qosst-alice is not shipped with a default configuration file but the default configuration file of QOSST can be generated using the following command

qosst configuration create

This will create the configuration file at the config.toml default location. The documentation of this command can be found at the page Command Line Interface (CLI) of the qosst core documentation.

Once the default configuration file is created, the whole [bob] section can be removed. The [alice] and [frame] sections must then be completed to reach the expected behaviour, and to connect to the good hardware. Here are some link that can be useful for the documentation:

Starting the server

The server can then be started using the simple command

qosst-alice -f config.toml

It can also be useful to get the more logs by adding one or several -v:

qosst-alice -f config.toml -vv

with the following relation:

  • No -v: Only print errors and critical errors;

  • -v: Same as above with warnings added;

  • -vv: Same as above with info added;

  • -vvv: all logs.

More information on the command line can be found here.

It is recommended to start Alice’s server with -vv. If you do so, in the absence of any client, the last line should read

DATE - qosst_alice.alice - INFO - Waiting for a client to connect.

If not, then something have probably gone wrong either in the configuration file or in the connection to the hardware and you should check the logs to get more information.