Skip to content

Commit

Permalink
Merge pull request #149 from ut-issl/feature/tlm_cmd_generator_as_sub…
Browse files Browse the repository at this point in the history
…module

tlm cmd generator を submodule として持たせる
  • Loading branch information
chutaro authored Aug 1, 2023
2 parents 6ca86d6 + b550b9f commit 605722a
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 19 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[submodule "src/src_core"]
path = src/src_core
url = https://github.com/ut-issl/c2a-core
[submodule "tools/tlm_cmd_generator"]
path = tools/tlm_cmd_generator
url = https://github.com/ut-issl/c2a-tlm-cmd-code-generator.git
24 changes: 5 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@
- For SILS test
- [S2E-AOBC](https://github.com/ut-issl/s2e-aobc) v3.0.0
- Telemetry/Command interface
- [tlm-cmd-generator](https://github.com/ut-issl/c2a-tlm-cmd-code-generator)
- Version: [ISSL Branch](https://github.com/ut-issl/c2a-tlm-cmd-code-generator/tree/feature/issl)
- [WINGS](https://gitlab.com/ut_issl/wings/wings)
- How to use
- `The main developers` of the AOCS module directly use this repository to add new features and improve the module.
Expand Down Expand Up @@ -57,8 +55,8 @@
- The term `body-fixed frame` in the codes and tlm/cmd database means `the body-fixed frame of the AOCS module`. It does not necessarily coincide with the body-fixed frame of your satellite.

## For main developers
## How to clone the repository
- This repository includes [c2a-core](https://github.com/ut-issl/c2a-core) with the `git submodule`. Please use the following commands to construct the directory.
### How to clone the repository
- This repository includes [c2a-core](https://github.com/ut-issl/c2a-core) and [tlm-cmd-generator](https://github.com/ut-issl/c2a-tlm-cmd-code-generator) as the `git submodule`. Please use the following commands to construct the directory.
```
$ git clone [email protected]:ut-issl/c2a-aobc.git
$ cd c2a-aobc/
Expand Down Expand Up @@ -108,22 +106,10 @@
### How to edit TLM/CMD (Telemetry/Command)
1. Edit TLM/CMD DB in `c2a-aobc/database/`
- Please find detailed information on [How to use TLM/CMD DB](https://github.com/ut-issl/tlm-cmd-db).
2. Execute `tlm-cmd-generator` and generate source codes.
2. Execute `tools/tlm_cmd_generator` and generate source codes.
- [How to use tlm-cmd-generator](https://github.com/ut-issl/c2a-tlm-cmd-code-generator)
- Checkout to the latest [feature/issl](https://github.com/ut-issl/c2a-tlm-cmd-code-generator/tree/feature/issl) branch.
- Edit the `settings.json` as follows.
```
{
"path_to_src" : "Relative path to c2a-aobc/src/",
"path_to_db" : "Relative path to c2a-aobc/database/",
"db_prefix" : "ISSL6U_AOBC",
"tlm_id_range" : ["0x00", "0x100"],
"is_cmd_prefixed_in_db" : 1,
"input_file_encoding" : "utf-8",
"output_file_encoding" : "utf-8",
"is_main_obc" : 0
}
```
- Just use the version specified in the submodule.
- It is set to read `tools/tlm_cmd_gen_config.json` as the config file.
### Development style
Expand Down
10 changes: 10 additions & 0 deletions tools/tlm_cmd_gen_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"path_to_src" : "../../src/",
"path_to_db" : "../../database/",
"db_prefix" : "ISSL6U_AOBC",
"tlm_id_range" : ["0x00", "0x100"],
"is_cmd_prefixed_in_db" : 1,
"input_file_encoding" : "utf-8",
"output_file_encoding" : "utf-8",
"is_main_obc" : 0
}
1 change: 1 addition & 0 deletions tools/tlm_cmd_generator
Submodule tlm_cmd_generator added at f1e73f

0 comments on commit 605722a

Please sign in to comment.