Telemetry: Create ICD

Đang mở
  • Có gì không ổn?
#161 0 bình luận 0 reaction 1 người được giao Xem trên GitHub

@ETSells đang làm issue này rồi.

Từ ngày 8/10/2026.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
15/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Sôi nổi
Công nghệ
c
Lĩnh vực
documentation, embedded-iot

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
C
Star
4
Fork
2
Merge trung bình
5 ngày 18 giờ
Pull request đã merge (30 ngày)
4

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của SunDevilRocketry/mod

Tất cả issue của SunDevilRocketry/mod

Issue tương tự

Thêm issue về C

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.