Imported from GitHub: wasa-rockoon/WOBC · commit 07a8c34 · license MIT

Description

WASAロケットプロジェクト 共通電装基盤

README

View this project on CADLAB.io.

WOBC

WOBCは，WASAロケットプロジェクトにおける電装関連の共通基盤を確立することを目的としたプロジェクトである． 開発した回路や基板の設計情報，プログラムといった資産を再利用しやすい形で整備することで， 開発スピードを向上させるとともに引き継ぎや教育を効率的に行えるようにする．

用語

ユニット

単独で動作する，システムの基本単位．例：ロケット電装，CanSat電装，地上局

1つ以上のモジュールから構成される．

モジュール

コンポーネントを一枚の基板上に配置した，物理的な単位．例：地上局モジュール，通信モジュール

モジュールには必ずマイコンが含まれ，コンポーネントを制御する． ユニットを構成するモジュール間はバスで接続される．

コンポーネント

ユニットを構成する，意味のある一つの機能単位．例：電源管理，姿勢決定，モーター駆動

ハードウェアおよびプログラムはコンポーネント単位で開発する．

パケット

ユニットやコンポーネント間でやり取りするデータの形式． 詳しくはWCPPを参照．

開発

モジュールやコンポーネントは，全てこのリポジトリに格納する（Monorepoスタイル）．

Gitの運用

• 開発者ごとに，develop/your_name ブランチを作成する．
• 全体に反映したい変更ができたらPull Requestを作成し，責任者にレビューを依頼する．
• コンポーネントおよびモジュール作成の際は自分のブランチとは別に，feature/CompornentOrModule_nameブランチを作成する．
• コンポーネント・モジュールが完成したらPull Requestを作成し，責任者にレビューを依頼する．
• 責任者は変更をレビューし，問題なければmainブランチにマージする．（回路・基板のレビューにはCADLAB.ioを使うと便利)

Github Copilotの学生無料

昨今コーディング作業にAI Agentの活用が主流になってきていると思います．ただ無料枠で利用していてもすぐトークンを使い切ってしまったり，選べるモデルが少なかったりと不便なことが多いかと思います．そこで個人的にはGithub Copilotの学生無料を利用することを推奨しています．導入方法についてはドキュメントにあるリンクから参照してください．

作業ログ

Github Copilotの利用にあわせて，作業ログを作ることを習慣化してほしいと思います．おもにコーディング作業についてですが，

• 前にも同じようなエラーが出てたけど，どうやって解消したんだっけとか
• 過去にも似たようなもの作ってたらしいけど，資料が残っていないとか

色々と引継ぎが上手くいっていないような事象を見かけます．非常にもったいないというか二度手間なことが多いので，ちゃんとノウハウを蓄積できるようにしましょう．

具体的には docsのフォルダにenv:毎でフォルダを作りその中でtemplateを参考にしてAIに作らせてください．タスク毎に作るのが良いかと思います．

ドキュメント

• develop: 詳細な開発の手順
• kicad: KiCADを用いた回路・基板設計マニュアル
• github-copilot: Github Copilotの導入マニュアル
• components: コンポーネントとその機能，インターフェースの一覧
• modules: モジュールとその機能，構成コンポーネントの一覧
• unit: ユニット一覧
• library: WOBCライブラリの使い方