Skip to content

Commit

Permalink
updating readme with Cosmos example instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Jbsco authored Jan 25, 2024
1 parent 852a704 commit 918b4ef
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions src/assembly/linux/main/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,17 +80,18 @@ Replace the contents of these text files with the contents of the corresponding
adamant_example/src/assembly/linux/build/plugin/Config
```

If the Cosmos and Admant example project directories are adjacent:
The Cosmos plugin uses a default CRC protocol provided by Cosmos, but also needs a custom protocol to apply Adamant' command packet checksum correctly. The protocol file is located in the Adamant directory at:

```
$ cp adamant_example/src/assembly/linux/build/plugin/Config/linux_example_ccsds_commands.txt cosmos-project/openc3-cosmos-linux-example/targets/LINUX_EXAMPLE/cmd_tlm/cmd.txt
$ cp adamant_example/src/assembly/linux/build/plugin/Config/linux_example_ccsds_telemetry.txt cosmos-project/openc3-cosmos-linux-example/targets/LINUX_EXAMPLE/cmd_tlm/tlm.txt
$ cp adamant_example/src/assembly/linux/build/plugin/Config/linux_example_ccsds_plugin.txt cosmos-project/openc3-cosmos-linux-example/plugin.txt
adamant/gnd/cosmos/cmd_checksum.rb
```

The Cosmos plugin uses a default CRC protocol provided by Cosmos, but needs a custom protocol to apply Adamant' command packet checksum correctly. Copy the protocol ruby file from `adamant/gnd/cosmos/` to the `cosmos-project/openc3-cosmos-linux-example/targets/LINUX_EXAMPLE/lib` directory:
If the Cosmos and Admant example project directories are adjacent, complete the configuration by running:

```
$ cp adamant_example/src/assembly/linux/build/plugin/Config/linux_example_ccsds_commands.txt cosmos-project/openc3-cosmos-linux-example/targets/LINUX_EXAMPLE/cmd_tlm/cmd.txt
$ cp adamant_example/src/assembly/linux/build/plugin/Config/linux_example_ccsds_telemetry.txt cosmos-project/openc3-cosmos-linux-example/targets/LINUX_EXAMPLE/cmd_tlm/tlm.txt
$ cp adamant_example/src/assembly/linux/build/plugin/Config/linux_example_ccsds_plugin.txt cosmos-project/openc3-cosmos-linux-example/plugin.txt
$ cp adamant/gnd/cosmos/cmd_checksum.rb cosmos-project/openc3-cosmos-linux-example/targets/LINUX_EXAMPLE/lib/cmd_checksum.rb
```

Expand Down

0 comments on commit 918b4ef

Please sign in to comment.