Telemetry: Create ICD

オープン
#161 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

@ETSells がすでに取り組んでいます。

2026年10月8日 から。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
15/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
活発
技術スタック
c

調査の方向性

Start from telemetry.h and inventory every platform-specific define and message struct the telemetry protocol currently uses. The issue asks for a versioned interface control document (X.Y versioning: adding messages bumps Y, structural changes bump X) that re-defines shared structures such as the dashboard dump and servo offsets. Done looks like a committed ICD plus a telemetry.h free of platform-specific defines, reviewed by the telemetry SME (@ETSells). Expect design-heavy work; no tests or concrete entry points are named in the payload.

索引モデルが issue の本文から書いたものです。

説明

advanced documentation

Version: v2.8.0

Describe the feature you'd like
Create an interface control document for the telemetry protocol. This way we can:

  • Re-define internal structures to be re-used across platforms (i.e. dashboard dump structure, servo offsets)
  • Enable forward/backwards compatibility among minor versions (vX.Y -> if X is the same, no re-definitions have been made, and incrementing Y only means messages were added. if X changes, backwards compatibility is not maintained).

While here, focus on removing external dependencies in telemetry.h (i.e. requiring platform-specific defines).

Describe alternatives you've considered
N/A

Additional context
N/A

Points of Contact
@ETSells: Telemetry SME

主要言語
C
スター
4
フォーク
2
平均マージ
5日 18時間
マージ済み PR(30日)
4

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

SunDevilRocketry/mod のほかの issue

SunDevilRocketry/mod の issue をすべて見る

似ている issue

C の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。