Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

インデントのスペースを GFM に準拠する #177

Merged
merged 3 commits into from
Nov 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 27 additions & 27 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@
C2A に関する説明の棲み分けは,次のようになっています.

- C2A のコードとそのコメント
- マスター情報
- 変数や構造体,関数などの定義などを Doxygen 形式で記述
- マスター情報
- 変数や構造体,関数などの定義などを Doxygen 形式で記述
- C2A リファレンス: https://github.com/ut-issl/c2a-reference
- C2A のコードから自動生成されるもの (Doxygen)
- 変数や構造体の定義,関数の相関図なども閲覧可能
- C2A のコードから自動生成されるもの (Doxygen)
- 変数や構造体の定義,関数の相関図なども閲覧可能
- 本ドキュメント
- マスター情報はコードとそのコメントなため,それを補足する情報など
- C2A 全体の説明
- 設計思想
- 規則など
- 操作方法や設定方法などの手順
- などなど
- したがって,マスター情報の二重管理を避けるため,本ドキュメントには,変数定義の説明などは記載しないこと!
- マスター情報はコードとそのコメントなため,それを補足する情報など
- C2A 全体の説明
- 設計思想
- 規則など
- 操作方法や設定方法などの手順
- などなど
- したがって,マスター情報の二重管理を避けるため,本ドキュメントには,変数定義の説明などは記載しないこと!

以上より,本ドキュメントと合わせてコードを見ることを推奨する.
(@ドキュメント記入者: 各ドキュメントから関連コードにリンクが張ってある状態が望ましい.)
Expand All @@ -27,25 +27,25 @@ C2A に関する説明の棲み分けは,次のようになっています.
## 目次

1. General Information
1. [Overview](./general/overview.md)
1. [Release](./general/release.md)
1. [Coding Rule](./general/coding_rule.md)
1. [Coding Acronyms](./general/coding_acronyms.md)
1. [Overview](./general/overview.md)
1. [Release](./general/release.md)
1. [Coding Rule](./general/coding_rule.md)
1. [Coding Acronyms](./general/coding_acronyms.md)
1. Application Layer
1. [Overview](./application/overview.md)
1. How to add a application
1. [Overview](./application/overview.md)
1. How to add a application
1. Core Layer
1. Overview
1. [Communication](./core/communication.md)
1. [Tips](./core/tips.md)
1. Overview
1. [Communication](./core/communication.md)
1. [Tips](./core/tips.md)
1. Component Driver
1. [Overview](./component_driver/overview.md)
1. [Communication with Components](./component_driver/communication_with_components.md)
1. [Overview](./component_driver/overview.md)
1. [Communication with Components](./component_driver/communication_with_components.md)
1. Development
1. [Development Environment](./development/development_environment.md)
1. [Tools](./development/tools.md)
1. [Development Environment](./development/development_environment.md)
1. [Tools](./development/tools.md)
1. SILS
1. [c2a-sils-runtime](./sils/c2a_sils_runtime.md)
1. [S2E Integration](./sils/s2e_integration.md)
1. [c2a-sils-runtime](./sils/c2a_sils_runtime.md)
1. [S2E Integration](./sils/s2e_integration.md)
1. Tips
1. [Parameter Settings](./tips/parameter_settings.md)
1. [Parameter Settings](./tips/parameter_settings.md)
24 changes: 12 additions & 12 deletions docs/application/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

## Application
- Application とは,以下の4つに分類される.
- Core
- User Defined
- Middleware
- Driver Instance
- Core
- User Defined
- Middleware
- Driver Instance
- Application は,以下の要素によって構成される.
- Application 実体
- 内部状態を保存する AppInfo 構造体
- 初期化関数 (initializer)
- 実行関数 (executor)
- コマンド
- テレメトリ
- Application 実体
- 内部状態を保存する AppInfo 構造体
- 初期化関数 (initializer)
- 実行関数 (executor)
- コマンド
- テレメトリ

## Application実体
### 内部状態を保存する AppInfo構造体
Expand All @@ -28,8 +28,8 @@
## コマンド
- 処理の最小単位
- 以下のような処理をする
- アプリケーションの一部処理を単独で行う
- アプリケーションの内部状態を更新する
- アプリケーションの一部処理を単独で行う
- アプリケーションの内部状態を更新する


## テレメトリ
Expand Down
42 changes: 21 additions & 21 deletions docs/component_driver/communication_with_components.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,14 @@ https://github.com/arkedge/c2a-core/blob/45d78a05c339c285b5aa0c2fcbf57c1b105137e

#### 各フィールドの説明
- Version ID
- `0x00`: バージョン不定
- `0x01`: Version 1
- `0x00`: バージョン不定
- `0x01`: Version 1
- Tlm / Cmd Count
- 送信 Packet 毎にインクリメントされていくカウンタ
- 送信 Packet 毎にインクリメントされていくカウンタ
- Tlm / Cmd ID
- Packet 種別を表す ID
- Packet 種別を表す ID
- User Data Field
- バイト単位で格納されたユーザーデータ
- バイト単位で格納されたユーザーデータ

なお,すべてのフィールドのバイトオーダはビッグエンディアンとする.

Expand All @@ -72,20 +72,20 @@ https://github.com/arkedge/c2a-core/blob/45d78a05c339c285b5aa0c2fcbf57c1b105137e

#### 各フィールドの説明
- STX
- Frame 先頭識別子
- `0xEB 0x90` 固定
- Frame 先頭識別子
- `0xEB 0x90` 固定
- Packet Length
- Packet Field の長さ
- Packet Field の長さ
- CRC
- Packet Field 部分の CRC (Header は含めない)
- 使用する CRC の種類は CRC-16/CCITT-FALSE (CRC-16/AUTOSAR, CRC-16/IBM-3740 とも)
- `width=16, poly=0x1021, init=0xffff, refin=false, refout=false, xorout=0x0000, check=0x29b1, residue=0x0000`
- Packet Field 部分の CRC (Header は含めない)
- 使用する CRC の種類は CRC-16/CCITT-FALSE (CRC-16/AUTOSAR, CRC-16/IBM-3740 とも)
- `width=16, poly=0x1021, init=0xffff, refin=false, refout=false, xorout=0x0000, check=0x29b1, residue=0x0000`
- ETX
- Frame 終端識別子
- `0xC5 0x79` 固定
- Frame 終端識別子
- `0xC5 0x79` 固定
- Packet Field
- バイト単位で格納された送信 Packet
- EB90 Packet や Common Packet などが格納される
- バイト単位で格納された送信 Packet
- EB90 Packet や Common Packet などが格納される

なお,すべてのフィールドのバイトオーダはビッグエンディアンとする.

Expand All @@ -95,13 +95,13 @@ https://github.com/arkedge/c2a-core/blob/45d78a05c339c285b5aa0c2fcbf57c1b105137e
C2A 間通信によって,以下のような機能が提供される.

- OBC 間の簡易な Driver 実装と自動コード生成
- [c2a-code-generator](../../code-generator/) 参照.
- [`examples/mobc/src/src_user/Drivers/Aocs`](/examples/mobc/src/src_user/Drivers/Aocs/) などの多くのコードが自動生成される.
- [c2a-code-generator](../../code-generator/) 参照.
- [`examples/mobc/src/src_user/Drivers/Aocs`](/examples/mobc/src/src_user/Drivers/Aocs/) などの多くのコードが自動生成される.
- OBC と地上局でネットワークを形成.
- 地上局から MOBC をルーターとして, sub OBC へコマンド配送.
- sub OBC のテレメトリを MOBC を経由して地上局まで配送.
- OBC A から OBC B に対してコマンド発行 / テレメ送信.
- 他
- 地上局から MOBC をルーターとして, sub OBC へコマンド配送.
- sub OBC のテレメトリを MOBC を経由して地上局まで配送.
- OBC A から OBC B に対してコマンド発行 / テレメ送信.
- 他

C2A 間通信の具体的な実装については,本リポジトリに同封されている User Sample である [`examples/mobc`](/examples/mobc) と [`examples/subobc`](/examples/subobc) での通信(前者が MOBC,後者が AOBC を想定)を参考にされたい.
具体的なドライバのコードは以下となる.
Expand Down
6 changes: 3 additions & 3 deletions docs/component_driver/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Component Driver とは,各コンポーネントとの通信において, HW
- UART test: https://github.com/arkedge/c2a-core/blob/develop/examples/mobc/src/src_user/component_driver/etc/uart_test.c
- GS: https://github.com/arkedge/c2a-core/blob/develop/examples/mobc/src/src_user/component_driver/com/gs.c
- C2A 間通信:
- https://github.com/arkedge/c2a-core/blob/develop/examples/mobc/src/src_user/component_driver/aocs/aobc.c
- https://github.com/arkedge/c2a-core/blob/develop/examples/subobc/src/src_user/component_driver/etc/mobc.c
- https://github.com/arkedge/c2a-core/blob/develop/examples/mobc/src/src_user/component_driver/aocs/aobc.c
- https://github.com/arkedge/c2a-core/blob/develop/examples/subobc/src/src_user/component_driver/etc/mobc.c

が実装されているので,それを参考のこと.
`load_init_setting` については下を参照.
Expand Down Expand Up @@ -91,7 +91,7 @@ TBW
- コードの見通しの良さの大幅改良
- 高速化
- 複数のフレーム定義(=ヘッダフッタやフレーム長)に対応するためのStreamの新設
- これまでは定期・非定期で2つあったが,これがコードの見通しの良さとバグの温床になっていた
- これまでは定期・非定期で2つあったが,これがコードの見通しの良さとバグの温床になっていた
- varidationの強化

各ドライバの実装方法は,上で述べたように既存コードを参照してほしいが,初期化時にユーザー設定をデフォルト設定で上書きするための `load_init_setting` 関数ポインタを渡す必要がある.
Expand Down
Loading
Loading