#  How to Add an Application

## アプリ追加手順
以下手順を踏む

- アプリ用に新規にファイルを作成する
- ファイルにアプリ関数を追加する
  - 関数は以下形式にて定義する
    ```c
    AppInfo アプリ作成関数(void)
    {
      return AI_create_app_info("アプリ名（アプリを端的に表す文字列）", 初期化関数, 実行関数（エントリーポイント）);
    }
    ```
  - 別で定義されているアプリ定義ファイル (`app_registry.c`) より参照する形になるため、header ファイルにも定義を加える
- 内部状態を保存する AppInfo構造体 を定義する
    - アプリ内で参照する static 変数を定義する
      - AppInfo構造体はテレメトリで参照するため外部参照できるようにする
    - AppInfo構造体定義の一例（[Coding Rule](../general/coding_rule.md) も参照のこと）
      ```c
      static 構造体名 ファイル名_;
      const 構造体名* const ファイル名 = &ファイル名_;
      ```
- アプリを登録する
    - `src/src_user/applications/app_registry.c` にアプリを追加する
      ```c
      :
      :
      add_application_(アプリID, アプリ作成関数);
      :
      :
      ```
    - `src/src_user/applications/app_registry.h` の アプリID enum 定義に該当アプリの ID を追加する
    - `CMakeLists.txt`に作成したファイルの path を追加する
        - `CMakeLists.txt`の path は適宣探す
- アプリを Task List へ追加する（定期実行アプリの場合のみ）
    - `src/src_user/settings/modes/task_lists/xx.c` の定義関数に対象アプリ登録処理を追加する
      ```c
      void BCL_load_tl_xx(void)
      {
        :
        :
        BCL_tool_register_app(相対TI, アプリID);
        :
        :
      }
      ```


## テレメトリ追加手順
以下手順を踏む

- Tlm DB にテレメトリを追加する
    - Tlm DB のファイルに追加したいテレメトリを追加する
    - Tlm DB 内の Excel ファイルにある `Variable or Function Name` の欄に取得したいテレメトリの変数を追加する
    - Tlm DB の Path：`tlm-cmd-db/TLM_DB`
     - Tlm DB については https://github.com/arkedge/c2a-tlmcmddb/tree/main/tlm-cmd-db を参照
- c2a-code-generator を実行する
    - c2a-code-generator の config ファイルを設定する
    - c2a-code-generator を実行する
      - c2a-code-generator によりTlmCmd DBに登録されたコマンド定義ファイルが自動生成される
    - c2a-tlm-cmd-code-generator については https://github.com/arkedge/c2a-core/blob/main/code-generator/README.md を参照


### Tlm ID の採番について
Tlm ID の採番ルールについては，user 任意である．
一方で，様々な衛星でテレメトリをできる限り共通化したい（Tlm DB の csv を使いまわしたい）， core update を容易にしたい（core テレメトリをそのまま user に取り込みたい）などの理由から， [`/examples/mobc/tlm-cmd-db`](/examples/mobc/tlm-cmd-db) では次のようなゆるいルールを採用している．

採番の意図としては，次のようなものがある．
- 現状コマンドファイル等で Tlm ID がベタ書きされているので， Tlm ID の変更は最小限におさえる
- core のテレメトリと user のテレメトリや，似てる機能のテレメトリをまとめる
- Tlm の追加があり得るので，ID はゆとりをもって採番する

| Tlm ID | どのようなテレメトリを採番するか |
| -- | -- |
| `0x0*`  |  衛星基本テレメトリ（MOBC, PCDU, DR など） |
| `0x1*`  |  メモリ系（MEM, FLASH, NvRAM など） |
| `0x2*`  |  C2A基本機能（TL, BCT, TF, CA, CDIS など） |
| `0x3*`  |  C2A基本機能のための reserved |
| `0x4*`  |  C2A core の応用機能系（App 関連，Mode 関連など） |
| `0x5*`  |  C2A Event 系（EL, EHなど） |
| `0x6*`  |  ドライバ，コンポ関連（基本コンポなど） |
| `0x7*`  |  ドライバ，コンポ関連（通信系コンポなど） |
| `0x8*`  |  ドライバ，コンポ関連（デバッグ用，リプロなど，特殊なもの） |
| `0x9*` - `0xe*` | 特に規定せず（user で自由に利用） |
| `0xf*`  |  HK tlm 類（衛星によっては HK が複数あることも）， git rev，他 |


## コマンド追加手順
以下手順を踏む

- Cmd DB にコマンドを追加する
    - Cmd DB のファイルに追加したいコマンド（コマンド名、引数等）を追加する
    - Cmd DB の Path：`tlm-cmd-db/CMD_DB`
     - Cmd DB については https://github.com/arkedge/c2a-tlmcmddb/tree/main/tlm-cmd-db を参照
- 対象ファイルにコマンドを追加する
  - 対象のファイルにコマンド実行関数を追加する。対象ファイルが無ければアプリ追加手順を参考にファイルを作成する
  - 関数は以下形式にて定義する
    ```c
    CCP_CmdRet Cmd_コマンド名(const CommonCmdPacket* packet)
    ```
- コマンド関数の返り値は以下関数を用いる
  ```c
  return CCP_make_cmd_ret(コマンド実行結果, エラーコード)
  return CCP_make_cmd_ret_without_err_code(コマンド実行結果)
  ```
  - 別で定義されているコマンド定義ファイルより参照する形になるため、headerファイルにも定義を加える
- c2a-code-generator を実行する
    - c2a-code-generator の config ファイルを設定する
    - c2a-code-generator を実行する
      - c2a-code-generator によりTlmCmd DBに登録されたコマンド定義ファイルが自動生成される
    - c2a-tlm-cmd-code-generator については https://github.com/arkedge/c2a-core/blob/main/code-generator/README.md を参照