Protocol Documentation

Table of Contents

generic/sdsp_g.proto

Top

ConnectServerRequest

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

ServerAddress

管理サーバーアドレス

FieldTypeLabelDescription
grpc string

gRPCサーバーアドレスおよびポート

rest string

RESTサーバーベースURL

other string

その他形式

SpatialFigure

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

FieldTypeLabelDescription
identification SpatialIdentification

[oneof figure]

tube SpatialFigure.Tube

[oneof figure]

polygon SpatialFigure.Polygon

[oneof figure]

SpatialFigure.Polygon

多角形（表現形式検討中）

SpatialFigure.Tube

角柱形状

FieldTypeLabelDescription
start Point

始点座標

end Point

終点座標

radian float

1辺長(m)

SpatialIdentification

空間ID

FieldTypeLabelDescription
ID string

z/f/x/y

SpatialIdentifications

空間ID

FieldTypeLabelDescription
ID string repeated

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

GenericAPI

Method NameRequest TypeResponse TypeDescription
ConnectServer ConnectServerRequest Token

サーバー接続（ログイン） ユーザIDとパスワードでトークンを得る

airmobility/sdsp_a.proto

Top

AirspaceArrangement

FieldTypeLabelDescription
outof_space generic.v2.SpatialIdentifications

当該SDSP_UASの管理外の領域およびオーバーレイ領域

flyable_space generic.v2.SpatialIdentifications

指定範囲内の飛行許容領域。領域が変化し増えた場合は追加領域のみ通知。

occupied_space generic.v2.SpatialIdentifications

飛行許容領域から閉塞領域に変更された領域

error ErrorCode

DeleteObjectRequest

FieldTypeLabelDescription
object_id int64

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

DeleteObjectResponse

FieldTypeLabelDescription
error ErrorCode

DeleteRequest

DeleteRequest入力パラメータ定義

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

FieldTypeLabelDescription
object_id int64 repeated

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

GetObjectRequest

GetObject入力パラメータ定義

FieldTypeLabelDescription
object_id int64

登録IDの空間ID属性値を得る

GetValueRequest

FieldTypeLabelDescription
figure generic.v2.SpatialFigure

取得する領域

request_type ObjectType repeated

取得するオブジェクトのタイプ。バリアへの対応はオプション。

GetValueResponse

FieldTypeLabelDescription
values Objects repeated

error ErrorCode

PutObjectRequest

FieldTypeLabelDescription
object_id int64

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

overwrite bool

trueの場合は旧のデータを削除し入力の情報で上書き。falseの場合は入力の情報を追加、同じ空間IDであれば値を上書きする。

voxels Voxels

PutObjectResponse

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

FieldTypeLabelDescription
object_id int64

登録ID

error ErrorCode

PutReserveAreaRequest

FieldTypeLabelDescription
object_id int64

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

overwrite bool

trueの場合は旧のデータを削除し入力の情報で上書き。falseの場合は入力の情報を追加、同じ空間IDであれば値を上書きする。

area ValueReserveArea repeated

設定するエリア。

PutReserveAreaResponse

FieldTypeLabelDescription
object_id int64

登録ID

error ErrorCode

SelectAirspaceArrangementRequest

SelectAirspaceArrangement入力パラメータ定義

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

FieldTypeLabelDescription
figure generic.v2.SpatialFigure

取得する領域

period generic.v2.Period

取得する時間帯

include_reserve_area bool

trueで飛行計画で予約されたエリアやルートも除外する。trueへの対応はオプショナル。

SelectAirspaceArrangementResponse

FieldTypeLabelDescription
outof_space generic.v2.SpatialIdentifications

当該SDSP_UASの管理外の領域およびオーバーレイ領域

flyable_space generic.v2.SpatialIdentifications

飛行許容領域

error ErrorCode

SelectObjectRequest

指定エリア内に存在するオブジェクトを返す

FieldTypeLabelDescription
area generic.v2.SpatialFigure repeated

指定エリア。

type ObjectType

取得する地物の種類。バリアへの対応はオプション。

with_forecast_weather bool

天気予報情報を取得する

with_current_weather bool

現在の天候情報を取得する

microwave_carrier_code string optional

指定したキャリアの電波強度を取得する

SelectObjectResponse

指定エリア内に存在するオブジェクト

FieldTypeLabelDescription
object_id SelectObjectResponse.FlyableArea repeated

SelectObjectResponse.FlyableArea

FieldTypeLabelDescription
id generic.v2.SpatialIdentification

空間ID

current_weather ValueWeather.CurrentWeather optional

現況

forecast ValueWeather.Forecast optional

予報

microwave ValueMicrowave.MicrowaveInfomation optional

電波強度

ErrorCode

エラーコード

NameNumberDescription
ErrorCode_UNSPECIFIED 0

ErrorCode_Duplicate 1

重複
ErrorCode_AccessDeny 2

アクセス権限なし

AirMobilityAPI

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

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

Method NameRequest TypeResponse TypeDescription
PutObject PutObjectRequest PutObjectResponse

空間情報登録 オブジェクトを空間ID群で登録する。
GetObject GetObjectRequest Object stream

空間情報取得 オブジェクトの値を得る
DeleteObject DeleteObjectRequest DeleteObjectResponse

空間情報削除 空間情報を削除する。
GetValue GetValueRequest Objects stream

指定領域空間情報取得 指定した領域のリスク値などの空間情報の値を得る。
PutReserveArea PutReserveAreaRequest PutReserveAreaResponse

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

飛行許容空域取得 指定した領域および時刻を指定し、飛行許容領域の空間ID群を得る。 空域空間の値の取得にはGetValue()を利用する。 飛行許容領域は下記を含まない領域 ・バリア ・飛行制限空域 ・緊急用務空域 ・飛行計画空域 ・オーバーレイ
SelectAirspaceArrangementStream SelectAirspaceArrangementRequest AirspaceArrangement stream

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

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)