Protocol Documentation

Table of Contents

Top

aegs/clover/v1/clover_service.proto

CancelContactRequest

FieldTypeLabelDescription
contact_idint64キャンセルするコンタクトの ID

CancelContactResponse

FieldTypeLabelDescription
contactContactキャンセルされたコンタクト

CreateContactRequest

FieldTypeLabelDescription
satellite_idint64コンタクト対象の衛星の ID
ground_station_idint64コンタクトで使用する地上局の ID
aosgoogle.protobuf.Timestamp作成するコンタクトの AOS 時刻
losgoogle.protobuf.Timestamp作成するコンタクトの LOS 時刻

CreateContactResponse

FieldTypeLabelDescription
contactContact作成されたコンタクト

GetContactRequest

FieldTypeLabelDescription
contact_idint64取得するコンタクトの ID

GetContactResponse

FieldTypeLabelDescription
contactContact指定された ID に対応するコンタクト

GetGroundStationRequest

FieldTypeLabelDescription
ground_station_idint64取得する地上局の ID

GetGroundStationResponse

FieldTypeLabelDescription
ground_stationGroundStation指定された ID に対応する地上局

GetLatestTLERequest

FieldTypeLabelDescription
satellite_idint64TLE を取得する衛星の ID

GetLatestTLEResponse

FieldTypeLabelDescription
tle_recordTLERecord指定された衛星の最新の TLE 情報

GetSatelliteRequest

FieldTypeLabelDescription
satellite_idint64取得する衛星の ID

GetSatelliteResponse

FieldTypeLabelDescription
satelliteSatellite指定された ID に対応する衛星

ListAvailableGroundStationsRequest

FieldTypeLabelDescription
satellite_idint64利用可能な地上局を取得する衛星の ID

ListAvailableGroundStationsResponse

FieldTypeLabelDescription
ground_stationsGroundStationrepeated指定された衛星で利用可能な地上局のリスト

ListPassesRequest

FieldTypeLabelDescription
satellite_idint64パス算出の対象とする衛星の ID
ground_station_idsint64repeatedパス算出の対象とする地上局の ID のリスト

ListPassesResponse

FieldTypeLabelDescription
passesPassrepeatedパスのリスト。 リストは AOS 時刻の昇順でソートされている

ListSatellitesRequest

ListSatellitesResponse

FieldTypeLabelDescription
satellitesSatelliterepeatedクライアントがアクセス可能な衛星のリスト

ListUpcomingContactsRequest

FieldTypeLabelDescription
satellite_idint64コンタクトのリストを取得する対象の衛星 ID

ListUpcomingContactsResponse

FieldTypeLabelDescription
contactsContactrepeated指定された衛星を対象とした現在時刻以降のコンタクトのリスト

RegisterTLERequest

FieldTypeLabelDescription
satellite_idint64TLE を登録する衛星の ID
tleTLE登録する TLE

RegisterTLEResponse

FieldTypeLabelDescription
tle_recordTLERecord登録された TLE の情報

CloverService

アークエッジ・スペースの地上局予約サービス。

Method NameRequest TypeResponse TypeDescription
ListSatellitesListSatellitesRequestListSatellitesResponse衛星のリストを取得する。リストにはクライアントがアクセス可能な衛星しか含まれない。
GetSatelliteGetSatelliteRequestGetSatelliteResponse指定した衛星を取得する。
GetLatestTLEGetLatestTLERequestGetLatestTLEResponse指定した衛星の最新の TLE を取得する。
RegisterTLERegisterTLERequestRegisterTLEResponse指定した衛星の TLE を登録する。 TLE が不正な場合は INVALID_ARGUMENT (3) が、最新の TLE と同じものを登録しようとした場合は ALREADY_EXISTS (6) のエラーが返る。
ListAvailableGroundStationsListAvailableGroundStationsRequestListAvailableGroundStationsResponse指定した衛星について利用可能な地上局のリストを取得する。
GetGroundStationGetGroundStationRequestGetGroundStationResponse指定した地上局を取得する。
ListPassesListPassesRequestListPassesResponse指定した衛星、地上局をもとに直近14日間のパスのリストを取得する。
ListUpcomingContactsListUpcomingContactsRequestListUpcomingContactsResponse指定した衛星について、end_time が現在時刻以降のコンタクトのリストを取得する。
GetContactGetContactRequestGetContactResponse指定したコンタクトを取得する。
CreateContactCreateContactRequestCreateContactResponse新しいコンタクトを作成する。 指定された AOS/LOS に該当するパスが存在しない場合は INVALID_ARGUMENT (3) が、 すでに同じ衛星、地上局、時間帯でコンタクトが存在する場合は ALREADY_EXISTS (6) のエラーが返る。
CancelContactCancelContactRequestCancelContactResponse指定したコンタクトをキャンセルする。 キャンセル不能な状態の場合は FAILED_PRECONDITION (9) のエラーが返る。

Top

aegs/clover/v1/models.proto

Contact

コンタクト。 Clover においては、予約されたパスを表す。

FieldTypeLabelDescription
idint64コンタクトの ID
satellite_idint64コンタクト対象の衛星の ID
ground_station_idint64コンタクトで使用する地上局の ID
statusContact.Statusコンタクトのステータス
start_timegoogle.protobuf.Timestampコンタクトの開始時刻。 AOSに対してバッファを持たせた時刻が設定され、この時刻をもとに予約の排他制御が行われる
end_timegoogle.protobuf.Timestampコンタクトの終了時刻。 LOSに対してバッファを持たせた時刻が設定され、この時刻をもとに予約の排他制御が行われる
create_timegoogle.protobuf.Timestampコンタクトの作成日時
update_timegoogle.protobuf.Timestampコンタクトの更新日時。 基本的にはステータスの変更時刻を表す
passPassDetailsリクエスト時の TLE に基づいて計算されたパスの詳細。 GetContact の場合にのみ値が設定される。 コンタクト時刻の前後にパスが見つからなかった場合は値が設定されない

GroundStation

地上局。

FieldTypeLabelDescription
idint64地上局の ID
namestring地上局の名前
locationLatLngAlt地上局の位置

LatLngAlt

緯度・経度・高度からなる位置情報。 パスの計算に使用される。

FieldTypeLabelDescription
latitudedouble緯度 [deg]
longitudedouble経度 [deg]
altitudedouble楕円体高 [meter]

Pass

衛星パス。

FieldTypeLabelDescription
satelliteSatellite当該パスの衛星
ground_stationGroundStation当該パスの地上局
detailsPassDetails当該パスの AOS/LOS と最大仰角
is_availablebool当該パスがコンタクトとして予約可能かどうか

PassDetails

パスの AOS/LOS 時刻と最大仰角といった詳細情報。

FieldTypeLabelDescription
aosgoogle.protobuf.TimestampAOS (Acquisition of Signal) 時刻
losgoogle.protobuf.TimestampLOS (Loss of Signal) 時刻
max_elevationdouble最大仰角 [deg]

Satellite

衛星。

FieldTypeLabelDescription
idint64衛星の ID
namestring衛星の名前

TLE

TLE (Two-Line Elements)。

FieldTypeLabelDescription
line1stringTLE の1行目
line2stringTLE の2行目

TLERecord

登録された TLE の情報。

FieldTypeLabelDescription
idint64TLE の ID
tleTLE登録された TLE
register_timegoogle.protobuf.TimestampTLE の登録日時

Contact.Status

コンタクトの状態。

NameNumberDescription
STATUS_UNSPECIFIED0ステータスの値が設定されていない場合の値。 この値が設定された場合は異常な状態であるため、アークエッジ・スペースの担当者に連絡すること
STATUS_PENDING1局管理者の確認待ちの状態。 コンタクトを予約した直後の初期状態。 この状態から他の状態に遷移したあと、この状態に戻ることはない
STATUS_SCHEDULED2局管理者に承認され、コンタクトの予約が有効な状態
STATUS_REJECTED3局管理者に拒否され、コンタクトの予約が無効な状態 他の状態に遷移しない終端状態
STATUS_CANCELED4ユーザがコンタクトの予約をキャンセルした状態。 他の状態に遷移しない終端状態
STATUS_RUNNING5コンタクトが実行中の状態。 この状態になると、キャンセルできなくなる
STATUS_COMPLETED6コンタクトが完了した状態。 他の状態に遷移しない終端状態
STATUS_FAILED7コンタクトが何らかの理由で失敗した状態。 他の状態に遷移しない終端状態

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)