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

GetSatelliteSchemaの戻り値で各種descriptionを含めるように変更 #248

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

shunsuke-shimomura
Copy link
Contributor

概要

  • テレメトリとコマンドのスキーマを返すrpcサービスにdescriptionの情報がなかったので、追加を行った
  • それに伴ってgaia-ccsds-c2aのschemaとtmtc-c2aのregistryを修正した

変更の意図や背景

  • descriptionをtlmcmddbから持って来れるようにしたかったので、tlm/cmd registryを修正した
  • registryで必要な情報を保持できるようにするために、gaia-ccsds-c2aの中も修正した

発端となる Issue

#246 で内容を提案した

@KOBA789
Copy link
Member

KOBA789 commented Jun 12, 2024

tmtc-c2a 側の GetSatelliteSchema で各種 description を返したいというモチベーションには大いに同意で、その API の用途に鑑みて当然返されるべきと思います。

しかし、現状 の gaia-ccsds-c2a の schema ではテレメ・コマンドのビット列の表現に関することだけを保持する方針の設計になっており、こちら側に description 等のメタデータを持たせていいかどうかは悩ましいです。
gaia-ccsds-c2a の構造を変更せず、tmtc-c2a 側の変更だけで description を追加できるのならそれが最も望ましいと思っています。

Copy link
Member

@KOBA789 KOBA789 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

意見が二転三転して申し訳ないんですが、現実的な利便性を考えると、既に gaia-ccsds-c2a に from_tlmcmddb 関数があるし、description 入れちゃっていいやという結論に至りました。
ParamField の名前以外はよさそうです

gaia-ccsds-c2a/src/access/cmd/schema.rs Outdated Show resolved Hide resolved
@KOBA789 KOBA789 changed the title rpcの各所にdescriptionを追加 GetSatelliteSchemaの戻り値で各種descriptionを含めるように変更 Jun 12, 2024
@KOBA789 KOBA789 added this to the v2.0.0 milestone Jun 12, 2024
@KOBA789
Copy link
Member

KOBA789 commented Jun 12, 2024

メジャーバージョンアップを伴うのでマージ・リリースタイミングを調整します

@KOBA789 KOBA789 self-assigned this Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

tco/tmiv schemaとTmtcGenericC2aServerにdescription他を追加する
2 participants