From b550b9f68b7968940e7b53fd377d97017dedb6f6 Mon Sep 17 00:00:00 2001
From: chutaro <35984595+chutaro@users.noreply.github.com>
Date: Tue, 1 Aug 2023 17:53:38 +0900
Subject: [PATCH] add tlm cmd generator as submodule

---
 .gitmodules                   |  3 +++
 README.md                     | 24 +++++-------------------
 tools/tlm_cmd_gen_config.json | 10 ++++++++++
 tools/tlm_cmd_generator       |  1 +
 4 files changed, 19 insertions(+), 19 deletions(-)
 create mode 100644 tools/tlm_cmd_gen_config.json
 create mode 160000 tools/tlm_cmd_generator

diff --git a/.gitmodules b/.gitmodules
index 6f04ffbf..52073dcb 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -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
diff --git a/README.md b/README.md
index b0f5ba1e..133859a0 100644
--- a/README.md
+++ b/README.md
@@ -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.
@@ -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 git@github.com:ut-issl/c2a-aobc.git
     $ cd c2a-aobc/
@@ -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
diff --git a/tools/tlm_cmd_gen_config.json b/tools/tlm_cmd_gen_config.json
new file mode 100644
index 00000000..5c10da3b
--- /dev/null
+++ b/tools/tlm_cmd_gen_config.json
@@ -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
+}
diff --git a/tools/tlm_cmd_generator b/tools/tlm_cmd_generator
new file mode 160000
index 00000000..f1e73fa7
--- /dev/null
+++ b/tools/tlm_cmd_generator
@@ -0,0 +1 @@
+Subproject commit f1e73fa74bc03f154497a3b87f7ba243d4e0984a