Add canonical OrbPro FlatBuffer bindings

Author: TJKoury

docs/protocol-installation.md

@@ -37,7 +37,7 @@ Examples:
 - concrete multiaddrs
 - resolved listen ports
 - selected peer IDs
-- node-info URLs
+- deployment URLs
 - interface-keyed input bindings
 - scheduler bindings
 - hosted service bindings

schemas/orbpro/BaseTypes.fbs

@@ -0,0 +1,7 @@
+namespace orbpro;
+
+struct Vec3 {
+  x:double;
+  y:double;
+  z:double;
+}

schemas/orbpro/CatalogQueryBase.fbs

@@ -0,0 +1,8 @@
+namespace orbpro.query;
+
+enum CatalogQueryKind : ubyte {
+  ROWS = 0,
+  ENTITY_INDICES = 1,
+  VISIBILITY_MASK = 2,
+  CATALOG_ROW = 3
+}

schemas/orbpro/CatalogQueryRequest.fbs

@@ -0,0 +1,14 @@
+include "CatalogQueryBase.fbs";
+
+namespace orbpro.query;
+
+table CatalogQueryRequest {
+  query_kind:CatalogQueryKind = ROWS;
+  query:string;
+  entity_index:uint = 0;
+  max_count:uint = 0;
+  entity_count:uint = 0;
+}
+
+root_type CatalogQueryRequest;
+file_identifier "CQRQ";

schemas/orbpro/CatalogQueryResult.fbs

@@ -0,0 +1,17 @@
+include "CatalogQueryBase.fbs";
+include "EntityMetadata.fbs";
+
+namespace orbpro.query;
+
+table CatalogQueryResult {
+  query_kind:CatalogQueryKind = ROWS;
+  rows:[orbpro.entity.EntityMetadata];
+  entity_indices:[uint];
+  mask:[ubyte];
+  visible_count:uint = 0;
+  entity_index:uint = 0;
+  row:orbpro.entity.EntityMetadata;
+}
+
+root_type CatalogQueryResult;
+file_identifier "CQRS";

schemas/orbpro/EntityMetadata.fbs

@@ -0,0 +1,53 @@
+namespace orbpro.entity;
+
+enum EntityKind : ubyte {
+  ENTITY = 0,
+  SPACE = 1,
+  GROUND = 2,
+  AIRCRAFT = 3,
+  MISSILE = 4,
+  SHIP = 5,
+  VEHICLE = 6,
+  SENSOR = 7,
+  OTHER = 255
+}
+
+table EntityMetadata {
+  entity_id:string (required, key);
+  name:string;
+  entity_kind:EntityKind = ENTITY;
+  subtype:string;
+  parent_entity_id:string;
+  primary_schema_file_id:string;
+  primary_row_id:double = 0.0;
+  wasm_handle:uint = 0;
+  position_region_id:uint = 0;
+  position_record_index:uint = 0;
+  velocity_region_id:uint = 0;
+  velocity_record_index:uint = 0;
+  visibility_region_id:uint = 0;
+  visibility_record_index:uint = 0;
+  norad_cat_id:uint = 0;
+  object_name:string;
+  object_id:string;
+  cat_object_name:string;
+  cat_object_id:string;
+  facility_type:string;
+  search_text:string;
+  owner:string;
+  status_code:string;
+  launch_date:string;
+  launch_year:string;
+  orbit_regime:string;
+  period:double = 0.0;
+  inclination:double = 0.0;
+  apogee:double = 0.0;
+  perigee:double = 0.0;
+  mean_motion:double = 0.0;
+  eccentricity:double = 0.0;
+  bstar:double = 0.0;
+  has_gp:bool = false;
+}
+
+root_type EntityMetadata;
+file_identifier "ENTM";

schemas/orbpro/EntityStandardsLink.fbs

@@ -0,0 +1,18 @@
+namespace orbpro.entity;
+
+table EntityStandardsLink {
+  link_key:string (required, key);
+  entity_id:string (required);
+  entity_record_key:string (required);
+  entity_schema_file_id:string (required);
+  entity_row_id:double = 0.0;
+  record_key:string (required);
+  schema_name:string (required);
+  record_schema_file_id:string (required);
+  record_row_id:double = 0.0;
+  cascade_delete:bool = true;
+  updated_at_ms:double = 0.0;
+}
+
+root_type EntityStandardsLink;
+file_identifier "ESTL";

schemas/orbpro/Plugin.fbs

@@ -0,0 +1,8 @@
+namespace orbpro.plugin;
+
+table RawDataPayload {
+  type_id:string;
+  data:[ubyte];
+}
+
+root_type RawDataPayload;

schemas/orbpro/Propagator.fbs

@@ -0,0 +1,71 @@
+include "BaseTypes.fbs";
+
+namespace orbpro.propagator;
+
+enum ReferenceFrame : ubyte {
+  TEME = 0,
+  J2000 = 1,
+  ICRF = 2,
+  ECEF = 3,
+  MCI = 4,
+  MCMF = 5
+}
+
+enum StateFlags : uint {
+  NONE = 0,
+  VALID = 1,
+  IN_ECLIPSE = 2,
+  DECAYED = 4,
+  MANEUVERING = 8,
+  EXTRAPOLATED = 16,
+  HAS_COVARIANCE = 32
+}
+
+enum PropagatorSourceKind : ubyte {
+  UNKNOWN = 0,
+  SGP4 = 1
+}
+
+struct StateVector {
+  epoch:double;
+  position:orbpro.Vec3;
+  velocity:orbpro.Vec3;
+  reference_frame:ReferenceFrame;
+  flags:uint;
+}
+
+table PropagatorDescribeSourcesBatchRequest {
+  catalogHandle:uint = 0;
+  sourceHandles:[uint];
+}
+
+table PropagatorSourceDescription {
+  sourceHandle:uint = 0;
+  sourceKind:PropagatorSourceKind = UNKNOWN;
+  objectName:string;
+  objectId:string;
+  noradCatId:uint = 0;
+  epochJd:double = 0.0;
+  meanMotionRevPerDay:double = 0.0;
+  eccentricity:double = 0.0;
+  inclinationDeg:double = 0.0;
+  raOfAscNodeDeg:double = 0.0;
+  argOfPericenterDeg:double = 0.0;
+  meanAnomalyDeg:double = 0.0;
+  ephemerisType:int = 0;
+  classificationType:string;
+  elementSetNo:uint = 0;
+  revAtEpoch:uint = 0;
+  bstar:double = 0.0;
+  meanMotionDotRevPerDay2:double = 0.0;
+  meanMotionDdotRevPerDay3:double = 0.0;
+  perigeeKm:double = 0.0;
+  apogeeKm:double = 0.0;
+}
+
+table PropagatorDescribeSourcesBatchResult {
+  catalogHandle:uint = 0;
+  sources:[PropagatorSourceDescription];
+}
+
+root_type PropagatorDescribeSourcesBatchRequest;

schemas/orbpro/StandardsRecordIndex.fbs

@@ -0,0 +1,15 @@
+namespace orbpro.entity;
+
+table StandardsRecordIndex {
+  record_key:string (required, key);
+  schema_name:string (required);
+  schema_file_id:string (required);
+  row_id:double = 0.0;
+  role:string;
+  attached_via:string;
+  payload_kind:string;
+  updated_at_ms:double = 0.0;
+}
+
+root_type StandardsRecordIndex;
+file_identifier "STRI";