From bca6ecab35c4eb8011e96a42bdb1501b7c2f2c84 Mon Sep 17 00:00:00 2001 From: Federico Lolli <federico.lolli@skywarder.eu> Date: Mon, 30 Sep 2024 17:48:46 +0200 Subject: [PATCH] [README] updated readme --- README.md | 66 ++++++++++--------------------------------------------- 1 file changed, 12 insertions(+), 54 deletions(-) diff --git a/README.md b/README.md index dfb3f09..a79e0cd 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ In brief, ARPIST is a tool for simulating the transmission of telemetry data fro If you want to install just ARPIST (host tool) on your machine, you can do it with the following command: ```bash -cargo install -F tdl --git ssh://git@git.skywarder.eu/federico.lolli/arpist.git +cargo install --git ssh://git@git.skywarder.eu/federico.lolli/arpist.git ``` If you plan instead to install also the board-side tool, you can clone first the repository: @@ -31,7 +31,7 @@ git clone --recurse-submodules ssh://git@git.skywarder.eu/federico.lolli/arpist. And then install it with the following commands ```bash -cargo install -F tdl --path ./on-host +cargo install --path ./on-host ``` #### Board-side @@ -92,45 +92,36 @@ ARPIST needs a board with a radio module connected to a serial port to work. The Once the board has the correct entrypoint flashed and is connected to the serial port, you can run ARPIST (host-side) as follows, after installing it. -The most common use case is to parse a CSV file containing telemetry data and send it to the board. You can do it with the following command: +The most common use case is to parse two CSV file containing telemetry data and send it to the board, one low rate (`ROCKET_STATS_TM`) and one high rate (`ROCKET_FLIGHT_TM`). You can do it with the following command: ```bash -arpist csv <telemetry_file> +arpist <low_rate_telemetry_file> <high_rate_telemetry_file> ``` +All available logs (correctly formatted) are found in the `logs` folder. + **NOTE**: by default ARPIST will wait for a synchronization signal from the board before sending further data. If you want to disable this behavior, you can use the `--no-sync` option (or just the short `-n` flag). ```bash -arpist -n csv <telemetry_file> +arpist -n <low_rate_telemetry_file> <high_rate_telemetry_file> ``` By adding the `--verbose` option (or just the short `-v` flag), you can enable the verbose mode, which will print the sent packets to the standard output. ```bash -arpist -v csv <telemetry_file> +arpist -v <low_rate_telemetry_file> <high_rate_telemetry_file> ``` **NOTE**: if a single STM32 compatible board is connected to the serial port, ARPIST will automatically detect it and use it, so you can omit the `--port <serial_port>` option. -### TDL Integration - -If you want to send telemetry data to the board from a TDL file, you can do it with the following command: - -```bash -arpist tdl --lat <latitude> --lon <longitude> --alt <altitude> <tdl_file> -``` - -Keep in mind that the `--lat`, `--lon` and `--alt` options are mandatory and must be specified in order to send the telemetry data to the board with the correct initial GPS position fix. - ### Detailed Usage ``` -Usage: arpist [OPTIONS] <COMMAND> +Usage: arpist [OPTIONS] <LOW_RATE_FILE> <HIGH_RATE_FILE> -Commands: - tdl build mavlink packets from a TDL file - csv parse mavlink packets from a CSV file - help Print this message or the help of the given subcommand(s) +Arguments: + <LOW_RATE_FILE> The low rate telemetry CSV file to read from + <HIGH_RATE_FILE> The high rate telemetry CSV file to read from Options: -p, --port <PORT> The serial port to use @@ -139,36 +130,3 @@ Options: -v, --verbose The log level -h, --help Print help ``` - -CSV and TDL commands have their own options and arguments: - -Here the CSV command usage: - -``` -parse mavlink packets from a CSV file - -Usage: arpist csv <CSV_FILE> - -Arguments: - <CSV_FILE> The CSV file to read from - -Options: - -h, --help Print help -``` - -And here the TDL command usage: - -``` -build mavlink packets from a TDL file - -Usage: arpist tdl --lat <LAT> --lon <LON> --alt <ALT> <TDL_FILE> - -Arguments: - <TDL_FILE> The TDL file to read from - -Options: - -n, --lat <LAT> initial GPS latitude - -e, --lon <LON> initial GPS longitude - -u, --alt <ALT> initial GPS altitude - -h, --help Print help -``` -- GitLab