Skip to content

Commit

Permalink
Add telemetry recording play instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Valerian Saliou <[email protected]>
  • Loading branch information
valeriansaliou committed May 9, 2020
1 parent 5daf518 commit ea37d9f
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,22 @@ _Tested at Rust version: `rustc 1.43.0 (4fb7144ed 2020-04-20)`_

To run the Control UI, please ensure that your device first has an open serial connection with the motherboard.

Take note of the serial port used as an input on your Control UI board, and call:
_Note that the Control UI relies on the MakAir Telemetry library, which gets pulled from the [makair-telemetry](https://github.com/makers-for-life/makair-telemetry) repository._

1. `./makair-control --port=0` (where `--port` is your serial port ID, maybe /dev/ttyUSB0)
Take note of the serial port used as an input on your Control UI board, and call:

You may also play a pre-recorded file, by passing it as an input (this is handy while developing):
1. Run: `./makair-control --port=0` (where `--port` is your serial port ID, maybe /dev/ttyUSB0)

1. `./makair-control --input=../telemetry/records/few_cycles` (where `--input` is an UNIX file path)
You may also play a pre-recorded file, by passing it as an input (this is handy while developing; example records are available in the telemetry library repository):

_Note that the Control UI relies on the MakAir Telemetry library, that is pulled from the [makair-telemetry](https://github.com/makers-for-life/makair-telemetry) repository._
1. Pull the telemetry library (in the parent directory): `git pull https://github.com/makers-for-life/makair-telemetry.git`
2. Run an example (from the Control UI directory): `./makair-control --input=../makair-telemetry/records/few_cycles` (where `--input` is an UNIX file path)

## How To Build A Release? (Cross-Compile For ARM)

To cross-compile a new release for an ARM target (using MUSL; statically-linked libraries), you can call the `release_binaries.sh` script:

1. `./scripts/release_binaries.sh --version=1.0.0`
1. Run: `./scripts/release_binaries.sh --version=1.0.0`

_Make sure to replace the `version` script argument with the current release version. This is used for file naming purposes only._

Expand Down

0 comments on commit ea37d9f

Please sign in to comment.