Protocol Documentation

Table of Contents

common.proto

Top

ConnectRequest

FieldTypeLabelDescription
userID string

ユーザID

organizationID string

組織ID

password string

OptionalSpatialIdentification

FieldTypeLabelDescription
has_value bool

値を持っているか否か

spatial_id SpatialIdentification

空間ID

Period

期間

FieldTypeLabelDescription
start_time int64

開始時刻 UNIX Time (UTC sec)

end_time int64

終了時刻 UNIX Time (UTC sec)

Point

座標情報

FieldTypeLabelDescription
latitude double

WGS84

longitude double

WGS84

altitude float

altitude_attribute Point.AltitudeAttribute

SpatialIdentification

空間ID

FieldTypeLabelDescription
ID string

z/f/x/y

Token

FieldTypeLabelDescription
result Token.Code

token string

Point.AltitudeAttribute

NameNumberDescription
ALTITUDE_ATTRIBUTE_ELIPSOIDE 0

楕円球体面高(当面対象外)

ALTITUDE_ATTRIBUTE_MSL 1

ジオイド高

ALTITUDE_ATTRIBUTE_AGL 2

地上高(当面対象外)

Token.Code

NameNumberDescription
COMPLETE 0

ログイン成功

INVALID 3

パスワードが無効

UNAVAILABLE_UAV 4

許容されない機体(他組織など)

INTERNAL_ERROR 10

sdsp.proto

Top

AirspaceArrangement

AIM_SelectAirspaceArrangement出力パラメータ定義

ユーザ追加は要素番号30以降を利用すること

FieldTypeLabelDescription
flyable_space SpatialFigure

飛行可能領域

occupied_space SpatialFigure

飛行可能領域から閉塞領域に変更された領域

error ErrorCode

AirspaceValue

空域空間の情報

FieldTypeLabelDescription
area AirspaceValue.AirArea

[oneof Airspace_info] 飛行空域

emergency AirspaceValue.Emergency

[oneof Airspace_info] 緊急用務空域

AirspaceValue.AirArea

FieldTypeLabelDescription
attr AirspaceValue.AirArea.AirAreaAttribute

RA

reference string

素となる情報へのリンク

AirspaceValue.Emergency

緊急用務空域

FieldTypeLabelDescription
reference string

Emergency attr = 1 ; // 不要? 素となる情報へのリンク

DeleteRequest

AIM_DeleteRequest入力パラメータ定義

ユーザ追加は要素番号30以降を利用すること

FieldTypeLabelDescription
object_id int64 repeated

リクエストしたUserIDが登録したUserIDと不一致の場合はエラー。

DeleteResponse

AIM_DeleteRequest出力パラメータ定義

ユーザ追加は要素番号30以降を利用すること

FieldTypeLabelDescription
error ErrorCode

GetValueRequest

AIM_GetValue入力パラメータ定義

ユーザ追加は要素番号30以降を利用すること

FieldTypeLabelDescription
figure SpatialFigure

取得する領域

request_type GetValueRequest.ObjectType repeated

取得するオブジェクトのタイプ

GetValuetResponse

AIM_GetValue出力パラメータ定義

ユーザ追加は要素番号30以降を利用すること

FieldTypeLabelDescription
values SpatialIdentifierInformation repeated

error ErrorCode

GroundRisk

検討中

FieldTypeLabelDescription
risk float

リスク値

MicroWave

検討中

FieldTypeLabelDescription
RSI float

電波強度

PhysicalBarrierValue

物標。地上の物理的な障害物

空域のバリア(ロジカルなバリア)はAirspaceで定義する。

FieldTypeLabelDescription
period SpatialIdentifier.Common.Protocol.Period

有効期間

terrain PhysicalBarrierValue.Terrain

地形 [oneof barrier_info]

building PhysicalBarrierValue.Building

建物 [oneof barrier_info]

PhysicalBarrierValue.Building

FieldTypeLabelDescription
attr PhysicalBarrierValue.Building.BuildingDefAttribute

reference string

素となる情報へのリンク

PhysicalBarrierValue.Terrain

FieldTypeLabelDescription
attr PhysicalBarrierValue.Terrain.TerrainAttribute

reference string

素となる情報へのリンク

PutAirspaceRequest

AIM_PutAirspaceRequest入力パラメータ定義

ユーザ追加は要素番号30以降を利用すること

設定できるエリアの種別(AirspaceInfo)はユーザ権限による

FieldTypeLabelDescription
object_id int64

登録ID。0の場合は新規登録。既存のIDではappend、User名が一致していない場合はエラー。

area SpatialFigure repeated

設定するエリア。

value AirspaceValue

areaに設定する値。予約空域(飛行計画予約)の重複はエラー。

PutAirspaceResponse

AIM_PutAirspaceArrangementRequest出力パラメータ定義

ユーザ追加は要素番号30以降を利用すること

FieldTypeLabelDescription
object_id int64

登録ID

error ErrorCode

PutReserveAreaRequest

AIM_PutReserveArea入力パラメータ定義

ユーザ追加は要素番号30以降を利用すること

FieldTypeLabelDescription
object_id int64

登録ID。0の場合は新規登録。既存のIDではappend、User名が一致していない場合はエラー。

area SpatialFigure repeated

設定するエリア。

value ReserveAreaValue

予約空域(飛行計画予約)

ReserveAreaValue

空域予約もしくは飛行計画予約

FieldTypeLabelDescription
period SpatialIdentifier.Common.Protocol.Period

有効期間

reference string

素となる情報へのリンク

SelectAirspaceArrangementRequest

AIM_SelectAirspaceArrangement入力パラメータ定義

ユーザ追加は要素番号30以降を利用すること

FieldTypeLabelDescription
figure SpatialFigure

取得する領域

period SpatialIdentifier.Common.Protocol.Period

取得する時間帯

SelectAirspaceArrangementResponse

AIM_SelectAirspaceArrangement出力パラメータ定義

ユーザ追加は要素番号30以降を利用すること

FieldTypeLabelDescription
flyable_space SpatialFigure

飛行可能領域

error ErrorCode

SelectAirspaceRequest

AIM_SelectAirspaceRequest入力パラメータ定義

ユーザ追加は要素番号30以降を利用すること

FieldTypeLabelDescription
area SpatialFigure repeated

対象エリア。指定がない場合はユーザーが登録したエリアすべて(飛行計画予約含む)。

SelectAirspaceResponse

AIM_SelectAirspaceRequest出力パラメータ定義

ユーザ追加は要素番号30以降を利用すること

FieldTypeLabelDescription
object_id int64 repeated

登録ID。

error ErrorCode

SpatialFigure

エリアや空間の領域の指定

FieldTypeLabelDescription
identification SpatialIdentifier.Common.Protocol.SpatialIdentification

[oneof figure]

tube SpatialFigure.Tube

[oneof figure]

polygon SpatialFigure.Polygon

[oneof figure]

SpatialFigure.Polygon

多角形(表現形式検討中)

SpatialFigure.Tube

円筒形形状

FieldTypeLabelDescription
start SpatialIdentifier.Common.Protocol.Point

始点座標

end SpatialIdentifier.Common.Protocol.Point

終点座標

radian float

半径(m)

SpatialIdentifierInformation

空間IDの値

FieldTypeLabelDescription
identification SpatialIdentifier.Common.Protocol.SpatialIdentification

空間ID

value SpatialValue

バリア空間情報

SpatialValue

FieldTypeLabelDescription
barrier PhysicalBarrierValue

[oneof infomation]

wether WeatherValue

[oneof infomation]

airspace AirspaceValue

[oneof infomation]

reserve_area ReserveAreaValue

[oneof infomation]

risk SpatialValue.RiskValue

SpatialValue.RiskValue

FieldTypeLabelDescription
risk float

リスク値。オプショナル。

WeatherValue

気象(2次元表現化については課題)

FieldTypeLabelDescription
current_weather WeatherValue.CurrentWeather

[oneof weather_info]

forecast WeatherValue.Forecast

[oneof weather_info]

WeatherValue.CurrentWeather

現況

無効データの表現方法は課題

FieldTypeLabelDescription
time int64

時刻

wind_direction float

風向(degree)

wind_speed float

風速(kt)

cloud_rate float

雲の割合(%)

temperature float

気温(°C)

dew_point float

露点温度(°C)

pressure float

気圧(hPa)

precipitation float

降水量(mm/h)

gggg string

運航上重要な気象

WeatherValue.Forecast

予報

FieldTypeLabelDescription
time int64

時刻

wind_direction float

風向(degree)

wind_speed float

風速(kt)

cloud_rate float

雲の割合(%)

precipitation float

降水量(mm/h)

AirspaceValue.AirArea.AirAreaAttribute

NameNumberDescription
FREE 0

制限なし。利用されることはない(PutAirspaceArrangementRequest()では設定せずDeleteを利用する,GetValuetResponse()でFreeの場合は空間IDは返却されない)

P 1

飛行禁止

R 2

飛行制限

K 3

訓練等空域

N 5

一時制限

ErrorCode

エラーコード

NameNumberDescription
ErrorCode_UNSPECIFIED 0

ErrorCode_Duplicate 1

重複

ErrorCode_AccessDeny 2

アクセス権限なし

GetValueRequest.ObjectType

対象物

NameNumberDescription
BARRIER 0

Terrain,Building

WEATHER 1

Airspace_AIRAREA 2

Airspaceについては種別ごとに指定可能とする。

Airspace_EMERGENCY 3

Airspaceについては種別ごとに指定可能とする。

Airspace_RESERCVE_AREA 4

Airspaceについては種別ごとに指定可能とする。

MICROWAVE 5

検討中

GROUND_RISK 6

検討中

PhysicalBarrierValue.Building.BuildingDefAttribute

NameNumberDescription
WITHOUT_BUILDING 0

建物等を含まない。利用されることはない(GetValueRequest()でBARRIERが指定された際には建物を含まないバリア情報は返らない)。

INCLUDE_BUILDING 1

建物を含む。(境界もしくは建物内)

INSIDE_BUILDING 2

ボクセル全体が建物内(教会と建物内の識別が可能な場合)

PhysicalBarrierValue.Terrain.TerrainAttribute

NameNumberDescription
BUILDING 0

地表面または地下を含まない。利用されることはない(GetValueRequest()でBARRIERが指定された際には建物を含まないバリア情報は返らない)。

INCLUDE_GROUND 1

地面(地表面および地下)

UNDER_GROUND 2

ボクセル全体が地下(地表面と地下の識別が可能な場合)

SDSP_A

エアモビリティ向け空間情報基盤

Connectで得たトークンをheaderにuseridと共に設定する

Method NameRequest TypeResponse TypeDescription
GEN_Connect .SpatialIdentifier.Common.Protocol.ConnectRequest .SpatialIdentifier.Common.Protocol.Token

サーバーへの接続(ログイン) ユーザIDとパスワードでトークンを得る

AIM_SelectAirspaceArrangement SelectAirspaceArrangementRequest SelectAirspaceArrangementResponse

飛行可能な空域取得 指定した領域および時刻で飛行可能な空域空間の空間ID群を得る。 空域空間の値の取得にはGetValue()を利用する。

AIM_SelectAirspaceArrangementStream SelectAirspaceArrangementRequest AirspaceArrangement stream

飛行可能な空域のストリームによる取得。 指定した領域および時刻で飛行可能な空域空間の空間ID群をストリームで得る。 次のようなケースに利用する。 ・大量のデータを分割して取得 ・変化を取得

AIM_GetValue GetValueRequest GetValuetResponse

空間情報取得 リスク値などの空間情報の値を得る。 Airspace以外(バリアなど)の取得も可能(ファイルimportではなくオンラインでの取得にも利用)

AIM_PutAirspace PutAirspaceRequest PutAirspaceResponse

空域登録 各種形状の空域空間を空間ID群で登録する。 エリア予約(飛行計画予約)の重複はエラー。

AIM_PutReserveArea PutReserveAreaRequest PutAirspaceResponse

空域予約 飛行計画(各種形状の空域空間)を空間ID群で登録する。 重複はエラー

AIM_SelectAirspace SelectAirspaceRequest SelectAirspaceResponse

空域情報取得 PutでUserが登録した空域のID(object_id)を取得する。

AIM_Delete DeleteRequest DeleteResponse

空域削除 Userが登録した空域を削除する。

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
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)