Protocol Documentation

aegs/clover/v1/clover_service.proto
aegs/clover/v1/models.proto
- BlobFile
- Contact
- GroundStation
- LatLngAlt
- Pass
- PassDetails
- Satellite
- TLE
- TLERecord
- Contact.Status
Scalar Value Types

aegs/clover/v1/clover_service.proto

CancelContactRequest

Field	Type	Label	Description
contact_id	int64		キャンセルするコンタクトの ID

CancelContactResponse

Field	Type	Label	Description
contact	Contact		キャンセルされたコンタクト

CreateContactRequest

Field	Type	Description
satellite_id	int64	コンタクト対象の衛星の ID
ground_station_id	int64	コンタクトで使用する地上局の ID
aos	google.protobuf.Timestamp	作成するコンタクトの AOS 時刻
los	google.protobuf.Timestamp	作成するコンタクトの LOS 時刻

CreateContactResponse

Field	Type	Label	Description
contact	Contact		作成されたコンタクト

GetContactRequest

Field	Type	Label	Description
contact_id	int64		取得するコンタクトの ID

GetContactResponse

Field	Type	Label	Description
contact	Contact		指定された ID に対応するコンタクト

GetGroundStationRequest

Field	Type	Label	Description
ground_station_id	int64		取得する地上局の ID

GetGroundStationResponse

Field	Type	Label	Description
ground_station	GroundStation		指定された ID に対応する地上局

GetLatestTLERequest

Field	Type	Label	Description
satellite_id	int64		TLE を取得する衛星の ID

GetLatestTLEResponse

Field	Type	Label	Description
tle_record	TLERecord		指定された衛星の最新の TLE 情報

GetSatelliteRequest

Field	Type	Label	Description
satellite_id	int64		取得する衛星の ID

GetSatelliteResponse

Field	Type	Label	Description
satellite	Satellite		指定された ID に対応する衛星

ListAvailableGroundStationsRequest

Field	Type	Label	Description
satellite_id	int64		利用可能な地上局を取得する衛星の ID

ListAvailableGroundStationsResponse

Field	Type	Label	Description
ground_stations	GroundStation	repeated	指定された衛星で利用可能な地上局のリスト

ListContactBlobFilesRequest

Field	Type	Label	Description
contact_id	int64		ファイルのリストを取得するコンタクトの ID

ListContactBlobFilesResponse

Field	Type	Label	Description
blob_files	BlobFile	repeated	コンタクトで生成されたファイルのリスト

ListPassesRequest

Field	Type	Label	Description
satellite_id	int64		パス算出の対象とする衛星の ID
ground_station_ids	int64	repeated	パス算出の対象とする地上局の ID のリスト

ListPassesResponse

Field	Type	Label	Description
passes	Pass	repeated	パスのリスト。リストは AOS 時刻の昇順でソートされている

ListPastContactsRequest

Field	Type	Label	Description
satellite_id	int64		コンタクトのリストを取得する対象の衛星 ID

ListPastContactsResponse

Field	Type	Label	Description
contacts	Contact	repeated	指定された衛星を対象とした過去14日以内のコンタクトのリスト

ListSatellitesRequest

ListSatellitesResponse

Field	Type	Label	Description
satellites	Satellite	repeated	クライアントがアクセス可能な衛星のリスト

ListUpcomingContactsRequest

Field	Type	Label	Description
satellite_id	int64		コンタクトのリストを取得する対象の衛星 ID

ListUpcomingContactsResponse

Field	Type	Label	Description
contacts	Contact	repeated	指定された衛星を対象とした現在時刻以降のコンタクトのリスト

RegisterTLERequest

Field	Type	Label	Description
satellite_id	int64		TLE を登録する衛星の ID
tle	TLE		登録する TLE

RegisterTLEResponse

Field	Type	Label	Description
tle_record	TLERecord		登録された TLE の情報

CloverService

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

Method Name	Request Type	Response Type	Description
ListSatellites	ListSatellitesRequest	ListSatellitesResponse	衛星のリストを取得する。リストにはクライアントがアクセス可能な衛星しか含まれない。
GetSatellite	GetSatelliteRequest	GetSatelliteResponse	指定した衛星を取得する。
GetLatestTLE	GetLatestTLERequest	GetLatestTLEResponse	指定した衛星の最新の TLE を取得する。
RegisterTLE	RegisterTLERequest	RegisterTLEResponse	指定した衛星の TLE を登録する。 TLE が不正な場合は INVALID_ARGUMENT (3) が、最新の TLE と同じものを登録しようとした場合は ALREADY_EXISTS (6) のエラーが返る。
ListAvailableGroundStations	ListAvailableGroundStationsRequest	ListAvailableGroundStationsResponse	指定した衛星について利用可能な地上局のリストを取得する。
GetGroundStation	GetGroundStationRequest	GetGroundStationResponse	指定した地上局を取得する。
ListPasses	ListPassesRequest	ListPassesResponse	指定した衛星、地上局をもとに直近14日間のパスのリストを取得する。
ListUpcomingContacts	ListUpcomingContactsRequest	ListUpcomingContactsResponse	指定した衛星について、end_time が現在時刻以降のコンタクトのリストを取得する。
ListPastContacts	ListPastContactsRequest	ListPastContactsResponse	指定した衛星について、end_time が過去14日以内のコンタクトのリストを取得する。
GetContact	GetContactRequest	GetContactResponse	指定したコンタクトを取得する。
CreateContact	CreateContactRequest	CreateContactResponse	新しいコンタクトを作成する。指定された AOS/LOS に該当するパスが存在しない場合は INVALID_ARGUMENT (3) が、すでに同じ衛星、地上局、時間帯でコンタクトが存在する場合は ALREADY_EXISTS (6) のエラーが返る。
CancelContact	CancelContactRequest	CancelContactResponse	指定したコンタクトをキャンセルする。キャンセル不能な状態の場合は FAILED_PRECONDITION (9) のエラーが返る。
ListContactBlobFiles	ListContactBlobFilesRequest	ListContactBlobFilesResponse	指定したコンタクトで得られたファイルのリストを取得する。コンタクトがファイルを生成するよう設定されていない場合は NOT_FOUND (5) のエラーが返る。

Top

aegs/clover/v1/models.proto

BlobFile

URL からダウンロード可能なファイル。

Field	Type	Description
url	string	ファイルをダウンロードするための URL
filename	string	ファイル名
size	int64	ファイルのサイズ [byte]

Contact

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

Field	Type	Description
id	int64	コンタクトの ID
satellite_id	int64	コンタクト対象の衛星の ID
ground_station_id	int64	コンタクトで使用する地上局の ID
status	Contact.Status	コンタクトのステータス
start_time	google.protobuf.Timestamp	コンタクトの開始時刻。 AOSに対してバッファを持たせた時刻が設定され、この時刻をもとに予約の排他制御が行われる
end_time	google.protobuf.Timestamp	コンタクトの終了時刻。 LOSに対してバッファを持たせた時刻が設定され、この時刻をもとに予約の排他制御が行われる
create_time	google.protobuf.Timestamp	コンタクトの作成日時
update_time	google.protobuf.Timestamp	コンタクトの更新日時。基本的にはステータスの変更時刻を表す
pass	PassDetails	リクエスト時の TLE に基づいて計算されたパスの詳細。 GetContact の場合にのみ値が設定される。コンタクト時刻の前後にパスが見つからなかった場合は値が設定されない

GroundStation

地上局。

Field	Type	Description
id	int64	地上局の ID
name	string	地上局の名前
location	LatLngAlt	地上局の位置

LatLngAlt

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

Field	Type	Description
latitude	double	緯度 [deg]
longitude	double	経度 [deg]
altitude	double	楕円体高 [meter]

Pass

衛星パス。

Field	Type	Description
satellite	Satellite	当該パスの衛星
ground_station	GroundStation	当該パスの地上局
details	PassDetails	当該パスの AOS/LOS と最大仰角
is_available	bool	当該パスがコンタクトとして予約可能かどうか

PassDetails

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

Field	Type	Description
aos	google.protobuf.Timestamp	AOS (Acquisition of Signal) 時刻
los	google.protobuf.Timestamp	LOS (Loss of Signal) 時刻
max_elevation	double	最大仰角 [deg]

Satellite

衛星。

Field	Type	Label	Description
id	int64		衛星の ID
name	string		衛星の名前

TLE

TLE (Two-Line Elements)。

Field	Type	Label	Description
line1	string		TLE の1行目
line2	string		TLE の2行目

TLERecord

登録された TLE の情報。

Field	Type	Description
id	int64	TLE の ID
tle	TLE	登録された TLE
register_time	google.protobuf.Timestamp	TLE の登録日時

Contact.Status

コンタクトの状態。

Name	Number	Description
STATUS_UNSPECIFIED	0	ステータスの値が設定されていない場合の値。この値が設定された場合は異常な状態であるため、アークエッジ・スペースの担当者に連絡すること
STATUS_PENDING	1	局管理者の確認待ちの状態。コンタクトを予約した直後の初期状態。この状態から他の状態に遷移したあと、この状態に戻ることはない
STATUS_SCHEDULED	2	局管理者に承認され、コンタクトの予約が有効な状態
STATUS_REJECTED	3	局管理者に拒否され、コンタクトの予約が無効な状態他の状態に遷移しない終端状態
STATUS_CANCELED	4	ユーザがコンタクトの予約をキャンセルした状態。他の状態に遷移しない終端状態
STATUS_RUNNING	5	コンタクトが実行中の状態。この状態になると、キャンセルできなくなる
STATUS_COMPLETED	6	コンタクトが完了した状態。他の状態に遷移しない終端状態
STATUS_FAILED	7	コンタクトが何らかの理由で失敗した状態。他の状態に遷移しない終端状態

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)

Clover API