From 715f4807a3828f30d1e216a71b1d82beccf3fbf6 Mon Sep 17 00:00:00 2001 From: Ryo Suzumoto Date: Tue, 13 Feb 2024 13:37:05 +0900 Subject: [PATCH 01/15] add build option doc --- docs/README.md | 1 + docs/general/build_options.md | 23 +++++++++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 docs/general/build_options.md diff --git a/docs/README.md b/docs/README.md index e46671ac0..3b67658e6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -30,6 +30,7 @@ C2A に関する説明の棲み分けは，次のようになっています． 1. [Overview](./general/overview.md) 1. [Requirements](./general/requirements.md) 1. [Release](./general/release.md) + 1. [Build Options](./general/build_options.md) 1. [Coding Rule](./general/coding_rule.md) 1. [Coding Acronyms](./general/coding_acronyms.md) 1. Application Layer diff --git a/docs/general/build_options.md b/docs/general/build_options.md new file mode 100644 index 000000000..75d15e594 --- /dev/null +++ b/docs/general/build_options.md @@ -0,0 +1,23 @@ +# Build Options + +## 概要 +主なビルドオプション (Cmake Option) について説明する． +なお，ここに含まれているオプションは利用可能なオプションのうち，ごく一部であることに注意すること． + + +## [`/CMakeLists.txt`](/CMakeLists.txt) +### コンパイルオプション +TBA + +### C2A Core 機能 +#### `C2A_USE_ALL_CORE_APPS` +`ON` にすることで，全ての Core Application をビルドする． +その場合， `/src_user/applications/CMakeLists.txt` にビルドしたい Core Application を適宜追加すること． + +https://github.com/arkedge/c2a-core/blob/459dbbf84d9587730f248ccbadb5a5745b28903d/examples/subobc/src/src_user/applications/CMakeLists.txt#L9-L13 + + +### その他 +#### `C2A_USE_STDINT_WRAPPER` +C89 ターゲットでビルドする際に `ON` にすることで，コンパイラが提供するものではなく，ユーザ定義の `stdint.h` を使う． +その場合， `src_user/library/stdint_impl.h` にユーザー定義の `stdint.h` を配置すること． From 9ded5ee0f42c65ffc39d1a6143c6725306722b9c Mon Sep 17 00:00:00 2001 From: Ryo Suzumoto Date: Tue, 13 Feb 2024 13:39:41 +0900 Subject: [PATCH 02/15] Update build_options.md --- docs/general/build_options.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/general/build_options.md b/docs/general/build_options.md index 75d15e594..c10e65f5a 100644 --- a/docs/general/build_options.md +++ b/docs/general/build_options.md @@ -11,12 +11,21 @@ TBA ### C2A Core 機能 #### `C2A_USE_ALL_CORE_APPS` -`ON` にすることで，全ての Core Application をビルドする． +`ON` にすることで，全ての [Core Application](/applications/) をビルドする． その場合， `/src_user/applications/CMakeLists.txt` にビルドしたい Core Application を適宜追加すること． https://github.com/arkedge/c2a-core/blob/459dbbf84d9587730f248ccbadb5a5745b28903d/examples/subobc/src/src_user/applications/CMakeLists.txt#L9-L13 +#### `C2A_USE_ALL_CORE_TEST_APPS` +`ON` にすることで，全ての [Core Test Application](/applications/test_app/) をビルドする． + + +#### `C2A_USE_ALL_CORE_LIB` +`ON` にすることで，全ての [Core Library](/library/) をビルドする． + + + ### その他 #### `C2A_USE_STDINT_WRAPPER` C89 ターゲットでビルドする際に `ON` にすることで，コンパイラが提供するものではなく，ユーザ定義の `stdint.h` を使う． From cc9e0813c4f64586e77acce8f722d2c83fa824de Mon Sep 17 00:00:00 2001 From: Ryo Suzumoto Date: Tue, 13 Feb 2024 13:44:02 +0900 Subject: [PATCH 03/15] update docs --- docs/core/ccsds.md | 2 +- docs/general/build_options.md | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/core/ccsds.md b/docs/core/ccsds.md index 869f4c506..5e22fb260 100644 --- a/docs/core/ccsds.md +++ b/docs/core/ccsds.md @@ -21,4 +21,4 @@ AOS Space Data Link Protocol や TC Space Data Link Protocol は，様々な設 （今後，適切にリファクタリングする予定．） また，本コードをコンパイル対象に加えると，少なくない RAM を static に確保してしまうため，デフォルトではコンパイル対象には含まれない． -コンパイル対象に含める場合は， FIXME: で設定すること． +コンパイル対象に含める場合は， `C2A_USE_CORE_CCSDS_AOS_SPACE_DATA_LINK_PROTOCOL`, `C2A_USE_CORE_CCSDS_TC_SPACE_DATA_LINK_PROTOCOL` オプションで設定すること（[General Information/Build Options](../general/build_options.md) を参照）． diff --git a/docs/general/build_options.md b/docs/general/build_options.md index c10e65f5a..b94892fe1 100644 --- a/docs/general/build_options.md +++ b/docs/general/build_options.md @@ -25,6 +25,14 @@ https://github.com/arkedge/c2a-core/blob/459dbbf84d9587730f248ccbadb5a5745b28903 `ON` にすることで，全ての [Core Library](/library/) をビルドする． +#### `C2A_ENABLE_MOBC_FEATURES` +`ON` にすることで，MOBC 向けの機能を有効化する．デフォルトは `OFF` であり， sub OBC 向けの実装となる． + + +#### `C2A_USE_CORE_CCSDS_AOS_SPACE_DATA_LINK_PROTOCOL`, `C2A_USE_CORE_CCSDS_TC_SPACE_DATA_LINK_PROTOCOL` +`ON` にすることで，CCSDS の AOS Space Data Link Protocol / TC Space Data Link Protocol の実装をビルドする． +[Core Layer/CCSDS](../core/ccsds.md) も参考のこと． + ### その他 #### `C2A_USE_STDINT_WRAPPER` From ba3ca95c98e8815c9721f94286c8563217014232 Mon Sep 17 00:00:00 2001 From: Ryo Suzumoto Date: Tue, 13 Feb 2024 13:45:32 +0900 Subject: [PATCH 04/15] Update ccsds.md --- docs/core/ccsds.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/core/ccsds.md b/docs/core/ccsds.md index 5e22fb260..c17decb2c 100644 --- a/docs/core/ccsds.md +++ b/docs/core/ccsds.md @@ -21,4 +21,7 @@ AOS Space Data Link Protocol や TC Space Data Link Protocol は，様々な設 （今後，適切にリファクタリングする予定．） また，本コードをコンパイル対象に加えると，少なくない RAM を static に確保してしまうため，デフォルトではコンパイル対象には含まれない． -コンパイル対象に含める場合は， `C2A_USE_CORE_CCSDS_AOS_SPACE_DATA_LINK_PROTOCOL`, `C2A_USE_CORE_CCSDS_TC_SPACE_DATA_LINK_PROTOCOL` オプションで設定すること（[General Information/Build Options](../general/build_options.md) を参照）． + + +## ビルドオプション +コンパイル対象に含める場合は， `C2A_USE_CORE_CCSDS_AOS_SPACE_DATA_LINK_PROTOCOL`, `C2A_USE_CORE_CCSDS_TC_SPACE_DATA_LINK_PROTOCOL` オプションをそれぞれ `ON` に設定すること（[General Information/Build Options](../general/build_options.md) を参照）． From 8b184c6401cfe736ada83e206981b71c4e194e05 Mon Sep 17 00:00:00 2001 From: Ryo Suzumoto Date: Thu, 28 Mar 2024 15:27:02 +0900 Subject: [PATCH 05/15] sed C2A_ENABLE_MOBC_FEATURES to C2A_MOBC_FEATURES --- docs/general/build_options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/general/build_options.md b/docs/general/build_options.md index b94892fe1..73f66ca20 100644 --- a/docs/general/build_options.md +++ b/docs/general/build_options.md @@ -25,7 +25,7 @@ https://github.com/arkedge/c2a-core/blob/459dbbf84d9587730f248ccbadb5a5745b28903 `ON` にすることで，全ての [Core Library](/library/) をビルドする． -#### `C2A_ENABLE_MOBC_FEATURES` +#### `C2A_MOBC_FEATURES` `ON` にすることで，MOBC 向けの機能を有効化する．デフォルトは `OFF` であり， sub OBC 向けの実装となる． From c8ecb0b20c29fbd32747596221ae90ac83cf63c3 Mon Sep 17 00:00:00 2001 From: Ryo Suzumoto Date: Fri, 29 Mar 2024 13:46:24 +0900 Subject: [PATCH 06/15] Update ccsds.md --- docs/core/ccsds.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/core/ccsds.md b/docs/core/ccsds.md index c17decb2c..948ff14f9 100644 --- a/docs/core/ccsds.md +++ b/docs/core/ccsds.md @@ -24,4 +24,5 @@ AOS Space Data Link Protocol や TC Space Data Link Protocol は，様々な設 ## ビルドオプション -コンパイル対象に含める場合は， `C2A_USE_CORE_CCSDS_AOS_SPACE_DATA_LINK_PROTOCOL`, `C2A_USE_CORE_CCSDS_TC_SPACE_DATA_LINK_PROTOCOL` オプションをそれぞれ `ON` に設定すること（[General Information/Build Options](../general/build_options.md) を参照）． +この実装をコンパイル対象に含める場合は，以下の `C2A_USE_CORE_CCSDS_AOS_SPACE_DATA_LINK_PROTOCOL`, `C2A_USE_CORE_CCSDS_TC_SPACE_DATA_LINK_PROTOCOL` オプションをそれぞれ `ON` に設定すること． +https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt#L26-L29 From 8745d2263d1187419fa21d52b0d9f83c5d19c8fa Mon Sep 17 00:00:00 2001 From: Ryo Suzumoto Date: Fri, 29 Mar 2024 13:59:22 +0900 Subject: [PATCH 07/15] update core app docs --- docs/README.md | 2 +- docs/application/overview.md | 13 +++++++++++++ docs/general/{build_options.md => build.md} | 15 +++++++++------ 3 files changed, 23 insertions(+), 7 deletions(-) rename docs/general/{build_options.md => build.md} (70%) diff --git a/docs/README.md b/docs/README.md index 3b67658e6..931462c89 100644 --- a/docs/README.md +++ b/docs/README.md @@ -30,7 +30,7 @@ C2A に関する説明の棲み分けは，次のようになっています． 1. [Overview](./general/overview.md) 1. [Requirements](./general/requirements.md) 1. [Release](./general/release.md) - 1. [Build Options](./general/build_options.md) + 1. [Build](./general/build.md) 1. [Coding Rule](./general/coding_rule.md) 1. [Coding Acronyms](./general/coding_acronyms.md) 1. Application Layer diff --git a/docs/application/overview.md b/docs/application/overview.md index e13b513f5..e71e06371 100644 --- a/docs/application/overview.md +++ b/docs/application/overview.md @@ -34,3 +34,16 @@ ## テレメトリ - アプリケーションの内部状態を送信するデータを規定する． + + +## c2a-core Application の利用 +次のコンパイルオプションを `ON` とすることで，c2a-core の Application を利用できる． +https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt#L18-L20 + +#### `C2A_USE_ALL_CORE_APPS` +`ON` にすることで，全ての [c2a-core Application](/applications/) をビルドする． +その場合， `/src_user/applications/CMakeLists.txt` にビルドしたい c2a-core Application を適宜追加すること． +https://github.com/arkedge/c2a-core/blob/459dbbf84d9587730f248ccbadb5a5745b28903d/examples/subobc/src/src_user/applications/CMakeLists.txt#L9-L13 + +#### `C2A_USE_ALL_CORE_TEST_APPS` +`ON` にすることで，全ての [c2a-core Test Application](/applications/test_app/) をビルドする． diff --git a/docs/general/build_options.md b/docs/general/build.md similarity index 70% rename from docs/general/build_options.md rename to docs/general/build.md index 73f66ca20..637ed6ee9 100644 --- a/docs/general/build_options.md +++ b/docs/general/build.md @@ -1,8 +1,14 @@ -# Build Options +# Build ## 概要 -主なビルドオプション (Cmake Option) について説明する． -なお，ここに含まれているオプションは利用可能なオプションのうち，ごく一部であることに注意すること． +ビルドに関連することをまとめる (TBW)． + + + +## Build Options +C2A User から利用するビルドオプションは， [`/CMakeLists.txt`](/CMakeLists.txt) で定義される． +https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt + ## [`/CMakeLists.txt`](/CMakeLists.txt) @@ -29,9 +35,6 @@ https://github.com/arkedge/c2a-core/blob/459dbbf84d9587730f248ccbadb5a5745b28903 `ON` にすることで，MOBC 向けの機能を有効化する．デフォルトは `OFF` であり， sub OBC 向けの実装となる． -#### `C2A_USE_CORE_CCSDS_AOS_SPACE_DATA_LINK_PROTOCOL`, `C2A_USE_CORE_CCSDS_TC_SPACE_DATA_LINK_PROTOCOL` -`ON` にすることで，CCSDS の AOS Space Data Link Protocol / TC Space Data Link Protocol の実装をビルドする． -[Core Layer/CCSDS](../core/ccsds.md) も参考のこと． ### その他 From 709a01008a99ddcf032cdd5b1f4357dbcf69d999 Mon Sep 17 00:00:00 2001 From: Ryo Suzumoto Date: Fri, 29 Mar 2024 14:05:06 +0900 Subject: [PATCH 08/15] update build option docs --- docs/general/build.md | 38 ++++++++------------------------------ 1 file changed, 8 insertions(+), 30 deletions(-) diff --git a/docs/general/build.md b/docs/general/build.md index 637ed6ee9..47feba7c9 100644 --- a/docs/general/build.md +++ b/docs/general/build.md @@ -4,40 +4,18 @@ ビルドに関連することをまとめる (TBW)． - ## Build Options C2A User から利用するビルドオプションは， [`/CMakeLists.txt`](/CMakeLists.txt) で定義される． https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt - -## [`/CMakeLists.txt`](/CMakeLists.txt) -### コンパイルオプション -TBA - -### C2A Core 機能 -#### `C2A_USE_ALL_CORE_APPS` -`ON` にすることで，全ての [Core Application](/applications/) をビルドする． -その場合， `/src_user/applications/CMakeLists.txt` にビルドしたい Core Application を適宜追加すること． - -https://github.com/arkedge/c2a-core/blob/459dbbf84d9587730f248ccbadb5a5745b28903d/examples/subobc/src/src_user/applications/CMakeLists.txt#L9-L13 - - -#### `C2A_USE_ALL_CORE_TEST_APPS` -`ON` にすることで，全ての [Core Test Application](/applications/test_app/) をビルドする． - - -#### `C2A_USE_ALL_CORE_LIB` -`ON` にすることで，全ての [Core Library](/library/) をビルドする． - - -#### `C2A_MOBC_FEATURES` -`ON` にすることで，MOBC 向けの機能を有効化する．デフォルトは `OFF` であり， sub OBC 向けの実装となる． - - +### ターゲット OBC +c2a-core には，通信機と接続され衛星の全体を司る MOBC (Main On-Board Computer) と，MOBC の配下に接続される sub OBC (AOCS OBC など) のそれぞれ向けの機能が存在する． +`C2A_MOBC_FEATURES` を `ON` にすることで，MOBC 向けの機能を有効化する．デフォルトは `OFF` であり， sub OBC 向けの実装となる． +https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt#L24 -### その他 -#### `C2A_USE_STDINT_WRAPPER` -C89 ターゲットでビルドする際に `ON` にすることで，コンパイラが提供するものではなく，ユーザ定義の `stdint.h` を使う． -その場合， `src_user/library/stdint_impl.h` にユーザー定義の `stdint.h` を配置すること． +### `stdint.h` +C89 ターゲットでビルドする際に `C2A_USE_STDINT_WRAPPER` を `ON` にすることで，コンパイラが提供するものではなく，ユーザ定義の `stdint.h` を使うことができる． +その場合， `src_user/library/stdint_impl.h` にユーザー定義の `stdint.h` を配置すること． +https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt#L14 From ec2a66f25b789bd8565817d28db008e894bb2839 Mon Sep 17 00:00:00 2001 From: Ryo Suzumoto Date: Fri, 29 Mar 2024 14:06:49 +0900 Subject: [PATCH 09/15] Update build.md --- docs/general/build.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/general/build.md b/docs/general/build.md index 47feba7c9..fd0e4d419 100644 --- a/docs/general/build.md +++ b/docs/general/build.md @@ -6,7 +6,7 @@ ## Build Options C2A User から利用するビルドオプションは， [`/CMakeLists.txt`](/CMakeLists.txt) で定義される． -https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt +https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt#L5-L31 ### ターゲット OBC From 814b4e3009ecedd86f2d7f7ec8f96de09e73d062 Mon Sep 17 00:00:00 2001 From: Ryo Suzumoto Date: Fri, 29 Mar 2024 14:07:56 +0900 Subject: [PATCH 10/15] fix typo --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index de896e4c7..2449fcee8 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -25,7 +25,7 @@ option(C2A_USE_SPACE_PACKET_AS_COMMON_PACKET "Use C2A-core Space Packet as Comm option(C2A_MOBC_FEATURES "Enable some features for MOBC" OFF) ## C2A CCSDS select -# See alse; /docs/core/ccsds.md +# See also; /docs/core/ccsds.md option(C2A_USE_CORE_CCSDS_AOS_SPACE_DATA_LINK_PROTOCOL "Use C2A-core CCSDS AOS SPACE DATA LINK PROTOCOL implementation" OFF) option(C2A_USE_CORE_CCSDS_TC_SPACE_DATA_LINK_PROTOCOL "Use C2A-core CCSDS TC SPACE DATA LINK PROTOCOL implementation" OFF) From b3a8c3107b74cd33accc85f1d59e25372452ef04 Mon Sep 17 00:00:00 2001 From: Ryo Suzumoto Date: Fri, 29 Mar 2024 14:13:03 +0900 Subject: [PATCH 11/15] fix typo --- docs/application/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/application/overview.md b/docs/application/overview.md index e71e06371..863ea394d 100644 --- a/docs/application/overview.md +++ b/docs/application/overview.md @@ -42,7 +42,7 @@ https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd8 #### `C2A_USE_ALL_CORE_APPS` `ON` にすることで，全ての [c2a-core Application](/applications/) をビルドする． -その場合， `/src_user/applications/CMakeLists.txt` にビルドしたい c2a-core Application を適宜追加すること． +`OFF` の場合， `/src_user/applications/CMakeLists.txt` にビルドしたい c2a-core Application を適宜追加すること． https://github.com/arkedge/c2a-core/blob/459dbbf84d9587730f248ccbadb5a5745b28903d/examples/subobc/src/src_user/applications/CMakeLists.txt#L9-L13 #### `C2A_USE_ALL_CORE_TEST_APPS` From 80d0b1567fb1c15c48f619a7d309c60299483d80 Mon Sep 17 00:00:00 2001 From: Ryo Suzumoto Date: Thu, 4 Apr 2024 20:51:52 +0900 Subject: [PATCH 12/15] docs --- docs/README.md | 3 ++- docs/general/architecture.md | 13 +++++++++++++ docs/general/{build.md => cmake.md} | 15 ++------------- 3 files changed, 17 insertions(+), 14 deletions(-) create mode 100644 docs/general/architecture.md rename docs/general/{build.md => cmake.md} (52%) diff --git a/docs/README.md b/docs/README.md index 931462c89..a2b585287 100644 --- a/docs/README.md +++ b/docs/README.md @@ -30,7 +30,8 @@ C2A に関する説明の棲み分けは，次のようになっています． 1. [Overview](./general/overview.md) 1. [Requirements](./general/requirements.md) 1. [Release](./general/release.md) - 1. [Build](./general/build.md) + 1. [Architecture](./general/architecture.md) + 1. [CMake](./general/cmake.md) 1. [Coding Rule](./general/coding_rule.md) 1. [Coding Acronyms](./general/coding_acronyms.md) 1. Application Layer diff --git a/docs/general/architecture.md b/docs/general/architecture.md new file mode 100644 index 000000000..1bb628d56 --- /dev/null +++ b/docs/general/architecture.md @@ -0,0 +1,13 @@ +# Architecture + +## 概要 +C2A が想定する，アーキテクチャについてまとめる (TBW)． + + +## OBC +想定するアーキテクチャでは，通信機と接続され衛星の全体を司る MOBC (Main On-Board Computer) と，MOBC の配下に接続される sub OBC (AOCS OBC など) のそれぞれ向けの機能が存在する． +そして，コンポーネントの中心に MOBC があり， sub OBC を含む各コンポーネントは MOBC と接続される． + +`C2A_MOBC_FEATURES` を `ON` にすることで，MOBC 向けの機能を有効化する． +デフォルトは `OFF` であり， sub OBC 向けの実装となる． +https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt#L24 diff --git a/docs/general/build.md b/docs/general/cmake.md similarity index 52% rename from docs/general/build.md rename to docs/general/cmake.md index fd0e4d419..cebfbb93d 100644 --- a/docs/general/build.md +++ b/docs/general/cmake.md @@ -1,20 +1,9 @@ -# Build - -## 概要 -ビルドに関連することをまとめる (TBW)． - - -## Build Options +# CMake +## CMake Options C2A User から利用するビルドオプションは， [`/CMakeLists.txt`](/CMakeLists.txt) で定義される． https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt#L5-L31 -### ターゲット OBC -c2a-core には，通信機と接続され衛星の全体を司る MOBC (Main On-Board Computer) と，MOBC の配下に接続される sub OBC (AOCS OBC など) のそれぞれ向けの機能が存在する． -`C2A_MOBC_FEATURES` を `ON` にすることで，MOBC 向けの機能を有効化する．デフォルトは `OFF` であり， sub OBC 向けの実装となる． -https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt#L24 - - ### `stdint.h` C89 ターゲットでビルドする際に `C2A_USE_STDINT_WRAPPER` を `ON` にすることで，コンパイラが提供するものではなく，ユーザ定義の `stdint.h` を使うことができる． その場合， `src_user/library/stdint_impl.h` にユーザー定義の `stdint.h` を配置すること． From c3da746bbfa537ac21f075c5db7b59a5883fb227 Mon Sep 17 00:00:00 2001 From: Ryo Suzumoto Date: Mon, 8 Apr 2024 16:28:43 +0900 Subject: [PATCH 13/15] apply review --- docs/application/overview.md | 2 +- docs/general/architecture.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/application/overview.md b/docs/application/overview.md index 863ea394d..c7ff96b71 100644 --- a/docs/application/overview.md +++ b/docs/application/overview.md @@ -41,7 +41,7 @@ https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt#L18-L20 #### `C2A_USE_ALL_CORE_APPS` -`ON` にすることで，全ての [c2a-core Application](/applications/) をビルドする． +`ON` にすることで，test app 以外の全ての [c2a-core Application](/applications/) をビルドする． `OFF` の場合， `/src_user/applications/CMakeLists.txt` にビルドしたい c2a-core Application を適宜追加すること． https://github.com/arkedge/c2a-core/blob/459dbbf84d9587730f248ccbadb5a5745b28903d/examples/subobc/src/src_user/applications/CMakeLists.txt#L9-L13 diff --git a/docs/general/architecture.md b/docs/general/architecture.md index 1bb628d56..bd799713a 100644 --- a/docs/general/architecture.md +++ b/docs/general/architecture.md @@ -8,6 +8,6 @@ C2A が想定する，アーキテクチャについてまとめる (TBW)． 想定するアーキテクチャでは，通信機と接続され衛星の全体を司る MOBC (Main On-Board Computer) と，MOBC の配下に接続される sub OBC (AOCS OBC など) のそれぞれ向けの機能が存在する． そして，コンポーネントの中心に MOBC があり， sub OBC を含む各コンポーネントは MOBC と接続される． -`C2A_MOBC_FEATURES` を `ON` にすることで，MOBC 向けの機能を有効化する． -デフォルトは `OFF` であり， sub OBC 向けの実装となる． + +デフォルトは sub OBC 向けの実装となっており， MOBC を開発するときは，`C2A_MOBC_FEATURES` を `ON` にし有効化する． https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt#L24 From 34657a0dd5aca2cb602ed26d38e4312c1e67474c Mon Sep 17 00:00:00 2001 From: Ryo Suzumoto Date: Mon, 8 Apr 2024 18:02:41 +0900 Subject: [PATCH 14/15] add C2A_USE_SPACE_PACKET_AS_COMMON_PACKET --- docs/core/communication.md | 3 +++ docs/general/architecture.md | 1 - 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/core/communication.md b/docs/core/communication.md index d0d063022..74d4eb1ea 100644 --- a/docs/core/communication.md +++ b/docs/core/communication.md @@ -22,6 +22,9 @@ C2A 内部を流れるパケットは以下の 3 つである． C2A 標準として， Space Packet が Core 内で定義されており，基本的にはこれを用いることを想定している． ただし，C2A 標準 Space Packet は後述する通り，Secondary Header が独自定義されている． +Common Packet の実装として，c2a-core が提供する Space Packet のデフォルト実装を用いる場合は，以下の `C2A_USE_SPACE_PACKET_AS_COMMON_PACKET` オプションを `ON` に設定すること． +https://github.com/arkedge/c2a-core/blob/12c6b614e15e3e5a24f416d640b8b024abca5965/CMakeLists.txt#L22 + ## C2A 標準 Space Packet 定義 C2A 標準 Space Packet は，CCSDS (Consultative Committee for Space Data Systems．宇宙データシステムの標準化を進めている機関) の Space Packet に準拠したものである（参考: [CCSDS SPACE PACKET PROTOCOL](https://public.ccsds.org/Pubs/133x0b2e1.pdf)）． diff --git a/docs/general/architecture.md b/docs/general/architecture.md index bd799713a..0cdd58baa 100644 --- a/docs/general/architecture.md +++ b/docs/general/architecture.md @@ -8,6 +8,5 @@ C2A が想定する，アーキテクチャについてまとめる (TBW)． 想定するアーキテクチャでは，通信機と接続され衛星の全体を司る MOBC (Main On-Board Computer) と，MOBC の配下に接続される sub OBC (AOCS OBC など) のそれぞれ向けの機能が存在する． そして，コンポーネントの中心に MOBC があり， sub OBC を含む各コンポーネントは MOBC と接続される． - デフォルトは sub OBC 向けの実装となっており， MOBC を開発するときは，`C2A_MOBC_FEATURES` を `ON` にし有効化する． https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt#L24 From ad0c895553639394479d78464a0ac0147c526631 Mon Sep 17 00:00:00 2001 From: Ryo Suzumoto Date: Wed, 10 Apr 2024 00:13:07 +0900 Subject: [PATCH 15/15] update docs --- docs/application/overview.md | 4 ++-- docs/core/ccsds.md | 2 +- docs/general/architecture.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/application/overview.md b/docs/application/overview.md index c7ff96b71..cef858c59 100644 --- a/docs/application/overview.md +++ b/docs/application/overview.md @@ -41,9 +41,9 @@ https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt#L18-L20 #### `C2A_USE_ALL_CORE_APPS` -`ON` にすることで，test app 以外の全ての [c2a-core Application](/applications/) をビルドする． +test app 以外の全ての [c2a-core Application](/applications/) をビルドする． `OFF` の場合， `/src_user/applications/CMakeLists.txt` にビルドしたい c2a-core Application を適宜追加すること． https://github.com/arkedge/c2a-core/blob/459dbbf84d9587730f248ccbadb5a5745b28903d/examples/subobc/src/src_user/applications/CMakeLists.txt#L9-L13 #### `C2A_USE_ALL_CORE_TEST_APPS` -`ON` にすることで，全ての [c2a-core Test Application](/applications/test_app/) をビルドする． +全ての [c2a-core Test Application](/applications/test_app/) をビルドする． diff --git a/docs/core/ccsds.md b/docs/core/ccsds.md index 948ff14f9..9a16a1f2e 100644 --- a/docs/core/ccsds.md +++ b/docs/core/ccsds.md @@ -24,5 +24,5 @@ AOS Space Data Link Protocol や TC Space Data Link Protocol は，様々な設 ## ビルドオプション -この実装をコンパイル対象に含める場合は，以下の `C2A_USE_CORE_CCSDS_AOS_SPACE_DATA_LINK_PROTOCOL`, `C2A_USE_CORE_CCSDS_TC_SPACE_DATA_LINK_PROTOCOL` オプションをそれぞれ `ON` に設定すること． +AOS Space Data Link Protocol と TC Space Data Link Protocol の各実装をコンパイル対象に含める場合は，以下の `C2A_USE_CORE_CCSDS_AOS_SPACE_DATA_LINK_PROTOCOL`, `C2A_USE_CORE_CCSDS_TC_SPACE_DATA_LINK_PROTOCOL` オプションをそれぞれ `ON` に設定すること． https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt#L26-L29 diff --git a/docs/general/architecture.md b/docs/general/architecture.md index 0cdd58baa..61b120260 100644 --- a/docs/general/architecture.md +++ b/docs/general/architecture.md @@ -5,7 +5,7 @@ C2A が想定する，アーキテクチャについてまとめる (TBW)． ## OBC -想定するアーキテクチャでは，通信機と接続され衛星の全体を司る MOBC (Main On-Board Computer) と，MOBC の配下に接続される sub OBC (AOCS OBC など) のそれぞれ向けの機能が存在する． +通信機と接続され衛星の全体を司る MOBC (Main On-Board Computer) と，MOBC の配下に接続される sub OBC (AOCS OBC など) が存在する． そして，コンポーネントの中心に MOBC があり， sub OBC を含む各コンポーネントは MOBC と接続される． デフォルトは sub OBC 向けの実装となっており， MOBC を開発するときは，`C2A_MOBC_FEATURES` を `ON` にし有効化する．