Skip to content
Snippets Groups Projects
Commit bca6ecab authored by Federico Lolli's avatar Federico Lolli
Browse files

[README] updated readme

parent 57c7b413
No related branches found
No related tags found
No related merge requests found
...@@ -19,7 +19,7 @@ In brief, ARPIST is a tool for simulating the transmission of telemetry data fro ...@@ -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: If you want to install just ARPIST (host tool) on your machine, you can do it with the following command:
```bash ```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: 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. ...@@ -31,7 +31,7 @@ git clone --recurse-submodules ssh://git@git.skywarder.eu/federico.lolli/arpist.
And then install it with the following commands And then install it with the following commands
```bash ```bash
cargo install -F tdl --path ./on-host cargo install --path ./on-host
``` ```
#### Board-side #### Board-side
...@@ -92,45 +92,36 @@ ARPIST needs a board with a radio module connected to a serial port to work. The ...@@ -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. 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 ```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). **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 ```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. 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 ```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. **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 ### Detailed Usage
``` ```
Usage: arpist [OPTIONS] <COMMAND> Usage: arpist [OPTIONS] <LOW_RATE_FILE> <HIGH_RATE_FILE>
Commands: Arguments:
tdl build mavlink packets from a TDL file <LOW_RATE_FILE> The low rate telemetry CSV file to read from
csv parse mavlink packets from a CSV file <HIGH_RATE_FILE> The high rate telemetry CSV file to read from
help Print this message or the help of the given subcommand(s)
Options: Options:
-p, --port <PORT> The serial port to use -p, --port <PORT> The serial port to use
...@@ -139,36 +130,3 @@ Options: ...@@ -139,36 +130,3 @@ Options:
-v, --verbose The log level -v, --verbose The log level
-h, --help Print help -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
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment