StreamEntityComponents
Returns a stream of entities with specified components populated.
StreamEntityComponentsRequestRequest- exactly 1 linear ring with 5 points (starting corner, 3 other corners and start again)
- each point has the same altitude corresponding with the plane of the rectangle
- each point has the same height (either all present and equal, or all not present)
lower_snake_case component names to include in response events, e.g. location. Only included components will populate.
Subscribe to all components. This should only be used in cases where you want all components. Setting both components_to_include and include_all_components is invalid and will be rejected.
The root node of a statement filter "tree". If provided, only entities matching the filter criteria will be streamed. The filter is applied dynamically so if a new entity matches, it will be included, and if an entity updates to no longer match, it will be excluded.
The field_path determines which field on an entity is being referenced in this predicate. For example: correlated.primary_entity_id would be primary_entity_id in correlated component.
The value determines the fixed value against which the entity field is to be compared. In the case of COMPARATOR_MATCH_ALL, the value contents do not matter as long as the Value is a supported type.
The comparator determines the manner in which the entity field and static value are compared. Comparators may only be applied to certain values. For example, the WITHIN comparator cannot be used for a boolean value comparison.
Comparators for: boolean, numeric, string, enum, position, timestamp, positions, and bounded shapes.
Comparators for: boolean, numeric, string, enum, position, and timestamp.
Comparators for: numeric, string, and timestamp.
The list_path specifies the repeated field on an entity to which this operation applies.
The list_comparator specifies how to compose the boolean results from the child statement for each member of the specified list.
The statement is a new expression tree conceptually rooted at type of the list. It determines how each member of the list is evaluated.
The field_path determines which field on an entity is being referenced in this predicate. For example: correlated.primary_entity_id would be primary_entity_id in correlated component.
The value determines the fixed value against which the entity field is to be compared. In the case of COMPARATOR_MATCH_ALL, the value contents do not matter as long as the Value is a supported type.
The comparator determines the manner in which the entity field and static value are compared. Comparators may only be applied to certain values. For example, the WITHIN comparator cannot be used for a boolean value comparison.
Comparators for: boolean, numeric, string, enum, position, timestamp, positions, and bounded shapes.
Comparators for: boolean, numeric, string, enum, position, and timestamp.
Comparators for: numeric, string, and timestamp.
The field_path determines which field on an entity is being referenced in this predicate. For example: correlated.primary_entity_id would be primary_entity_id in correlated component.
The value determines the fixed value against which the entity field is to be compared. In the case of COMPARATOR_MATCH_ALL, the value contents do not matter as long as the Value is a supported type.
The comparator determines the manner in which the entity field and static value are compared. Comparators may only be applied to certain values. For example, the WITHIN comparator cannot be used for a boolean value comparison.
Comparators for: boolean, numeric, string, enum, position, timestamp, positions, and bounded shapes.
Comparators for: boolean, numeric, string, enum, position, and timestamp.
Comparators for: numeric, string, and timestamp.
The list_path specifies the repeated field on an entity to which this operation applies.
The list_comparator specifies how to compose the boolean results from the child statement for each member of the specified list.
The statement is a new expression tree conceptually rooted at type of the list. It determines how each member of the list is evaluated.
The field_path determines which field on an entity is being referenced in this predicate. For example: correlated.primary_entity_id would be primary_entity_id in correlated component.
The value determines the fixed value against which the entity field is to be compared. In the case of COMPARATOR_MATCH_ALL, the value contents do not matter as long as the Value is a supported type.
The comparator determines the manner in which the entity field and static value are compared. Comparators may only be applied to certain values. For example, the WITHIN comparator cannot be used for a boolean value comparison.
Comparators for: boolean, numeric, string, enum, position, timestamp, positions, and bounded shapes.
Comparators for: boolean, numeric, string, enum, position, and timestamp.
Comparators for: numeric, string, and timestamp.
The field_path determines which field on an entity is being referenced in this predicate. For example: correlated.primary_entity_id would be primary_entity_id in correlated component.
The value determines the fixed value against which the entity field is to be compared. In the case of COMPARATOR_MATCH_ALL, the value contents do not matter as long as the Value is a supported type.
The comparator determines the manner in which the entity field and static value are compared. Comparators may only be applied to certain values. For example, the WITHIN comparator cannot be used for a boolean value comparison.
Comparators for: boolean, numeric, string, enum, position, timestamp, positions, and bounded shapes.
Comparators for: boolean, numeric, string, enum, position, and timestamp.
Comparators for: numeric, string, and timestamp.
The field_path determines which field on an entity is being referenced in this predicate. For example: correlated.primary_entity_id would be primary_entity_id in correlated component.
The value determines the fixed value against which the entity field is to be compared. In the case of COMPARATOR_MATCH_ALL, the value contents do not matter as long as the Value is a supported type.
The comparator determines the manner in which the entity field and static value are compared. Comparators may only be applied to certain values. For example, the WITHIN comparator cannot be used for a boolean value comparison.
Comparators for: boolean, numeric, string, enum, position, timestamp, positions, and bounded shapes.
Comparators for: boolean, numeric, string, enum, position, and timestamp.
Comparators for: numeric, string, and timestamp.
The list_path specifies the repeated field on an entity to which this operation applies.
The list_comparator specifies how to compose the boolean results from the child statement for each member of the specified list.
The statement is a new expression tree conceptually rooted at type of the list. It determines how each member of the list is evaluated.
The field_path determines which field on an entity is being referenced in this predicate. For example: correlated.primary_entity_id would be primary_entity_id in correlated component.
The value determines the fixed value against which the entity field is to be compared. In the case of COMPARATOR_MATCH_ALL, the value contents do not matter as long as the Value is a supported type.
The comparator determines the manner in which the entity field and static value are compared. Comparators may only be applied to certain values. For example, the WITHIN comparator cannot be used for a boolean value comparison.
Comparators for: boolean, numeric, string, enum, position, timestamp, positions, and bounded shapes.
Comparators for: boolean, numeric, string, enum, position, and timestamp.
Comparators for: numeric, string, and timestamp.
The list_path specifies the repeated field on an entity to which this operation applies.
The list_comparator specifies how to compose the boolean results from the child statement for each member of the specified list.
The statement is a new expression tree conceptually rooted at type of the list. It determines how each member of the list is evaluated.
The field_path determines which field on an entity is being referenced in this predicate. For example: correlated.primary_entity_id would be primary_entity_id in correlated component.
The value determines the fixed value against which the entity field is to be compared. In the case of COMPARATOR_MATCH_ALL, the value contents do not matter as long as the Value is a supported type.
The comparator determines the manner in which the entity field and static value are compared. Comparators may only be applied to certain values. For example, the WITHIN comparator cannot be used for a boolean value comparison.
Comparators for: boolean, numeric, string, enum, position, timestamp, positions, and bounded shapes.
Comparators for: boolean, numeric, string, enum, position, and timestamp.
Comparators for: numeric, string, and timestamp.
The list_path specifies the repeated field on an entity to which this operation applies.
The list_comparator specifies how to compose the boolean results from the child statement for each member of the specified list.
The statement is a new expression tree conceptually rooted at type of the list. It determines how each member of the list is evaluated.
The field_path determines which field on an entity is being referenced in this predicate. For example: correlated.primary_entity_id would be primary_entity_id in correlated component.
The value determines the fixed value against which the entity field is to be compared. In the case of COMPARATOR_MATCH_ALL, the value contents do not matter as long as the Value is a supported type.
The comparator determines the manner in which the entity field and static value are compared. Comparators may only be applied to certain values. For example, the WITHIN comparator cannot be used for a boolean value comparison.
Comparators for: boolean, numeric, string, enum, position, timestamp, positions, and bounded shapes.
Comparators for: boolean, numeric, string, enum, position, and timestamp.
Comparators for: numeric, string, and timestamp.
The field_path determines which field on an entity is being referenced in this predicate. For example: correlated.primary_entity_id would be primary_entity_id in correlated component.
The value determines the fixed value against which the entity field is to be compared. In the case of COMPARATOR_MATCH_ALL, the value contents do not matter as long as the Value is a supported type.
An array of LinearRings where the first item is the exterior ring and subsequent items are interior rings.
An extension hint that this polygon is a rectangle. When true this implies several things:
WGS84 geodetic latitude in decimal degrees.
WGS84 longitude in decimal degrees.
altitude as height above ellipsoid (WGS84) in meters. DoubleValue wrapper is used to distinguish optional from default 0.
Altitude as AGL (Above Ground Level) if the upstream data source has this value set. This value represents the entity's height above the terrain. This is typically measured with a radar altimeter or by using a terrain tile set lookup. If the value is not set from the upstream, this value is not set.
Altitude as ASF (Above Sea Floor) if the upstream data source has this value set. If the value is not set from the upstream, this value is not set.
The depth of the entity from the surface of the water through sensor measurements based on differential pressure between the interior and exterior of the vessel. If the value is not set from the upstream, this value is not set.
The comparator determines the manner in which the entity field and static value are compared. Comparators may only be applied to certain values. For example, the WITHIN comparator cannot be used for a boolean value comparison.
Comparators for: boolean, numeric, string, enum, position, timestamp, positions, and bounded shapes.
Comparators for: boolean, numeric, string, enum, position, and timestamp.
Comparators for: numeric, string, and timestamp.
Optional rate-limiting / down-sampling parameters, see RateLimit message for details.
Specifies a minimum duration in milliseconds after an update for a given entity before another one will be sent for the same entity. A value of 0 is treated as unset. If set, value must be >= 500. Example: if set to 1000, and 4 events occur (ms since start) at T0, T500, T900, T2100, then event from T0 will be sent at T0, T500 will be dropped, T900 will be sent at minimum of T1000, and T2100 will be sent on time (2100) This will only limit updates, other events will be sent immediately, with a delete clearing anything held
The period (in milliseconds) at which a Heartbeat message will be sent on the message stream. If this field is set to 0 then no Heartbeat messages are sent.
Subscribe to a finite stream of preexisting events which closes when there are no additional pre-existing events to process. Respects the filter specified on the StreamEntityComponentsRequest.
StreamEntityComponentsResponseResponseresponse stream will be fed all matching pre-existing live entities as CREATED, plus any new events ongoing.
- exactly 1 linear ring with 5 points (starting corner, 3 other corners and start again)
- each point has the same altitude corresponding with the plane of the rectangle
- each point has the same height (either all present and equal, or all not present)
entity was created.
entity was updated.
entity was deleted.
entity already existed, but sent on a new stream connection.
entity override was set after the entity expiration.
A Globally Unique Identifier (GUID) for your entity. If this field is empty, the Entity Manager API automatically generates an ID when it creates the entity.
A human-readable entity description that's helpful for debugging purposes and human traceability. If this field is empty, the Entity Manager API generates one for you.
Indicates the entity is active and should have a lifecycle state of CREATE or UPDATE. Set this field to true when publishing an entity.
The time when the entity was first known to the entity producer. If this field is empty, the Entity Manager API uses the current timestamp of when the entity is first received. For example, when a drone is first powered on, it might report its startup time as the created time. The timestamp doesn't change for the lifetime of an entity.
Future time that expires an entity and updates the is_live flag. For entities that are constantly updating, the expiry time also updates. In some cases, this may differ from is_live. Example: Entities with tasks exported to an external system must remain active even after they expire. This field is required when publishing a prepopulated entity. The expiry time must be in the future, but less than 30 days from the current time.
Human-readable descriptions of what the entity is currently doing.
A string that describes the activity that the entity is performing. Examples include "RECONNAISSANCE", "INTERDICTION", "RETURN TO BASE (RTB)", "PREPARING FOR LAUNCH".
A human-readable string that describes the role the entity is currently performing. E.g. "Team Member", "Commander".
Geospatial data related to the entity, including its position, kinematics, and orientation.
see Position definition for details.
WGS84 geodetic latitude in decimal degrees.
WGS84 longitude in decimal degrees.
altitude as height above ellipsoid (WGS84) in meters. DoubleValue wrapper is used to distinguish optional from default 0.
Altitude as AGL (Above Ground Level) if the upstream data source has this value set. This value represents the entity's height above the terrain. This is typically measured with a radar altimeter or by using a terrain tile set lookup. If the value is not set from the upstream, this value is not set.
Altitude as ASF (Above Sea Floor) if the upstream data source has this value set. If the value is not set from the upstream, this value is not set.
The depth of the entity from the surface of the water through sensor measurements based on differential pressure between the interior and exterior of the vessel. If the value is not set from the upstream, this value is not set.
Velocity in an ENU reference frame centered on the corresponding position. All units are meters per second.
Speed is the magnitude of velocity_enu vector [sqrt(e^2 + n^2 + u^2)] when present, measured in m/s.
The entity's acceleration in meters/s^2.
quaternion to translate from entity body frame to it's ENU frame
x, y, z are vector portion, w is scalar
Indicates uncertainty of the entity's position and kinematics.
Positional covariance represented by the upper triangle of the covariance matrix. It is valid to populate only the diagonal of the matrix if the full covariance matrix is unknown.
Velocity covariance represented by the upper triangle of the covariance matrix. It is valid to populate only the diagonal of the matrix if the full covariance matrix is unknown.
An ellipse that describes the certainty probability and error boundary for a given geolocation.
Defines the probability in percentage that an entity lies within the given ellipse: 0-1.
Defines the distance from the center point of the ellipse to the furthest distance on the perimeter in meters.
Defines the distance from the center point of the ellipse to the shortest distance on the perimeter in meters.
The orientation of the semi-major relative to true north in degrees from clockwise: 0-180 due to symmetry across the semi-minor axis.
Geospatial representation of the entity, including entities that cover an area rather than a fixed point.
WGS84 geodetic latitude in decimal degrees.
WGS84 longitude in decimal degrees.
altitude as height above ellipsoid (WGS84) in meters. DoubleValue wrapper is used to distinguish optional from default 0.
Altitude as AGL (Above Ground Level) if the upstream data source has this value set. This value represents the entity's height above the terrain. This is typically measured with a radar altimeter or by using a terrain tile set lookup. If the value is not set from the upstream, this value is not set.
Altitude as ASF (Above Sea Floor) if the upstream data source has this value set. If the value is not set from the upstream, this value is not set.
The depth of the entity from the surface of the water through sensor measurements based on differential pressure between the interior and exterior of the vessel. If the value is not set from the upstream, this value is not set.
WGS84 geodetic latitude in decimal degrees.
WGS84 longitude in decimal degrees.
altitude as height above ellipsoid (WGS84) in meters. DoubleValue wrapper is used to distinguish optional from default 0.
Altitude as AGL (Above Ground Level) if the upstream data source has this value set. This value represents the entity's height above the terrain. This is typically measured with a radar altimeter or by using a terrain tile set lookup. If the value is not set from the upstream, this value is not set.
Altitude as ASF (Above Sea Floor) if the upstream data source has this value set. If the value is not set from the upstream, this value is not set.
The depth of the entity from the surface of the water through sensor measurements based on differential pressure between the interior and exterior of the vessel. If the value is not set from the upstream, this value is not set.
An array of LinearRings where the first item is the exterior ring and subsequent items are interior rings.
An extension hint that this polygon is a rectangle. When true this implies several things:
Defines the distance from the center point of the ellipse to the furthest distance on the perimeter in meters.
Defines the distance from the center point of the ellipse to the shortest distance on the perimeter in meters.
The orientation of the semi-major relative to true north in degrees from clockwise: 0-180 due to symmetry across the semi-minor axis.
Optional height above entity position to extrude in meters. A non-zero value creates an elliptic cylinder
Defines the distance from the center point to the surface along the forward axis
Defines the distance from the center point to the surface along the side axis
Defines the distance from the center point to the surface along the up axis
Additional details on what the geospatial area or point represents, along with visual display details.
Engagement zones allow for engaging an entity if it comes within the zone of another entity.
Entity name displayed in the Lattice UI side panel. Also includes identifiers that other systems can use to reference the same entity.
an Anduril trackId_2
an Anduril trackId_1
an Anduril Sensor Point of Interest ID
NITF file title
Track repo alert ID
The best available version of the entity's display name.
If this entity is tracked by another entity, this component contains data related to how it's being tracked.
Quality score, 0-15, nil if none
Sensor hits aggregation on the tracked entity.
Estimated number of objects or units that are represented by this entity. Known as Strength in certain contexts (Link16) if UpperBound == LowerBound; (strength = LowerBound) If both UpperBound and LowerBound are defined; strength is between LowerBound and UpperBound (represented as string "Strength: 4-5") If UpperBound is defined only (LowerBound unset), Strength ≤ UpperBound If LowerBound is defined only (UpperBound unset), LowerBound ≤ Strength 0 indicates unset.
The radar cross section (RCS) is a measure of how detectable an object is by radar. A large RCS indicates an object is more easily detected. The unit is “decibels per square meter,” or dBsm
Timestamp of the latest tracking measurement for this entity.
The relative position of a track with respect to the entity that is tracking it. Used for tracks that do not yet have a 3D position. For this entity (A), being tracked by some entity (B), this LineOfBearing would express a ray from B to A.
The direction pointing from this entity to the detection
Origin (LLA) and attitude (relative to ENU) of a ray pointing towards the detection. The attitude represents a forward-left-up (FLU) frame where the x-axis (1, 0, 0) is pointing towards the target.
Bearing/elevation covariance matrix where bearing is defined in radians CCW+ about the z-axis from the x-axis of FLU frame and elevation is positive down from the FL/XY plane. mxx = bearing variance in rad^2 mxy = bearing/elevation covariance in rad^2 myy = elevation variance in rad^2
The estimated distance of the detection
The value of the measurement.
Estimated one standard deviation in same unit as the value.
The maximum distance of the detection
The value of the measurement.
Estimated one standard deviation in same unit as the value.
If this entity has been correlated or decorrelated to another one, this component contains information on the correlation or decorrelation.
This entity is the primary of a correlation meaning that it serves as the representative entity of the correlation set.
The secondary entity IDs part of this correlation.
This entity is a secondary of a correlation meaning that it will be represented by the primary of the correlation set.
The primary of this correlation.
Metadata about the correlation.
Who or what added this entity to the (de)correlation.
Indicates how the correlation will be distributed. Because a correlation is composed of multiple secondaries, each of which may have been correlated with different replication modes, the distribution of the correlation is composed of distributions of the individual entities within the correlation set. For example, if there are two secondary entities A and B correlated against a primary C, with A having been correlated globally and B having been correlated locally, then the correlation set that is distributed globally than what is known locally in the node.
The correlation is local only to the originating node and will not be distributed to other nodes in the mesh. In the case of conflicts, this correlation will override ones coming from other nodes. Local is always higher precedence than global regardless of the correlation type.
The correlation is distributed globally across all nodes in the mesh. Because an entity can only be part of one correlation, this is based on last-write-wins semantics, however, the correlation will also be stored locally in the originating node preventing any overrides. Global is always lower precedence than local regardless of the correlation type.
What type of (de)correlation was this entity added with.
The correlation was made manually by a human. Manual is higher precedence than automated assuming the same replication mode.
The correlation was automatically made by a service or some other automated process. Automated is lower precedence than manual assuming the same replication mode.
If present, this entity is a part of a correlation set.
The ID of the correlation set this entity belongs to.
This entity is the primary of a correlation set meaning that it serves as the representative entity of the correlation set.
This entity is not the primary of the correlation set. Note that there may not be a primary at all.
Additional metadata on this correlation.
Who or what added this entity to the (de)correlation.
Indicates how the correlation will be distributed. Because a correlation is composed of multiple secondaries, each of which may have been correlated with different replication modes, the distribution of the correlation is composed of distributions of the individual entities within the correlation set. For example, if there are two secondary entities A and B correlated against a primary C, with A having been correlated globally and B having been correlated locally, then the correlation set that is distributed globally than what is known locally in the node.
The correlation is local only to the originating node and will not be distributed to other nodes in the mesh. In the case of conflicts, this correlation will override ones coming from other nodes. Local is always higher precedence than global regardless of the correlation type.
The correlation is distributed globally across all nodes in the mesh. Because an entity can only be part of one correlation, this is based on last-write-wins semantics, however, the correlation will also be stored locally in the originating node preventing any overrides. Global is always lower precedence than local regardless of the correlation type.
What type of (de)correlation was this entity added with.
The correlation was made manually by a human. Manual is higher precedence than automated assuming the same replication mode.
The correlation was automatically made by a service or some other automated process. Automated is lower precedence than manual assuming the same replication mode.
If present, this entity was explicitly decorrelated from one or more entities. An entity can be both correlated and decorrelated as long as they are disjoint sets. An example would be if a user in the UI decides that two tracks are not actually the same despite an automatic correlator having correlated them. The user would then decorrelate the two tracks and this decorrelation would be preserved preventing the correlator from re-correlating them at a later time.
This will be specified if this entity was decorrelated against all other entities.
Metadata about the decorrelation.
A list of decorrelated entities that have been explicitly decorrelated against this entity which prevents lower precedence correlations from overriding it in the future. For example, if an operator in the UI decorrelated tracks A and B, any automated correlators would be unable to correlate them since manual decorrelations have higher precedence than automatic ones. Precedence is determined by both correlation type and replication mode.
The entity that was decorrelated against.
Metadata about the decorrelation.
View of the entity.
Ontology defines an entity's categorization in Lattice, and improves data retrieval and integration. Builds a standardized representation of the entity.
A string that describes the entity's high-level type with natural language.
A string that describes the entity's exact model or type.
The template used when creating this entity. Specifies minimum required components.
additional track required components: * location * mil_view
additional SPI required components: * location * mil_view * produced_by
additional asset required components: * location * mil_view * ontology
additional geo required components: * geo_shape * geo_details
additional SOI required components: * signal * location field should be populated if there is a fix. * mil_view * ontology
Details an entity's available sensors.
This generally is used to indicate a specific type at a more detailed granularity. E.g. COMInt or LWIR
sensor exists but is deliberately turned off
sensor is not operational but some reason other than being "Off" (e.g., equipment malfunction)
sensor is receiving information but in some reduced status (e.g., off calibration)
fully functional
sensor is being actively denied
The type of sensor
A human readable description of the sensor
RF configuration details of the sensor
Frequency ranges that are available for this sensor.
Bandwidth ranges that are available for this sensor.
Time of the latest detection from the sensor
Multiple fields of view for a single sensor component
The Id for one instance of a FieldOfView, persisted across multiple updates to provide continuity during smoothing. This is relevant for sensors where the dwell schedule is on the order of milliseconds, making multiple FOVs a requirement for proper display of search beams.
The Id of the mount the sensor is on.
The field of view the sensor projected onto the ground.
Center ray of the frustum projected onto the ground.
The origin and direction of the center ray for this sensor relative to the ENU frame. A ray which is aligned with the positive X axis in the sensor frame will be transformed into the ray along the sensor direction in the ENU frame when transformed by the quaternion contained in this pose.
Horizontal field of view in radians.
Vertical field of view in radians.
Sensor range in meters.
The mode that this sensor is currently in, used to display for context in the UI. Some sensors can emit multiple sensor field of views with different modes, for example a radar can simultaneously search broadly and perform tighter bounded tracking.
Details an entity's available payloads.
Identifying ID for the capability. This ID may be used multiple times to represent payloads that are the same capability but have different operational states
The number of payloads currently available in the configuration.
The target environments the configuration is effective against.
The operational state of this payload.
A human readable description of the payload
Details the entity's power source.
This is a map where the key is a unique id of the power source and the value is additional information about the power source.
Status of the power source.
Indeterminate condition of whether the power system is present or absent.
Power system is not configured/present. This is considered a normal/expected condition, as opposed to the system is expected to be present but is missing.
Power system is present and operating normally.
Power system is present and is in an expected disabled state. For example, if the generator was shut off for operational reasons.
Power system is non-functional.
Used to determine the type of power source.
Power level of the system. If absent, the power level is assumed to be unknown.
Set of human-readable messages with status of the power system. Typically this would be used in an error state to provide additional error information. This can also be used for informational messages.
Whether the power source is offloadable. If the value is missing (as opposed to false) then the entity does not report whether the power source is offloadable.
The primary data source provenance for this entity.
Name of the integration that produced this entity
Source data type of this entity. Examples: ADSB, Link16, etc.
An ID that allows an element from a source to be uniquely identified
The time, according to the source system, that the data in the entity was last modified. Generally, this should be the time that the source-reported time of validity of the data in the entity. This field must be updated with every change to the entity or else Entity Manager will discard the update.
Description of the modification source. In the case of a user this is the email address.
Provenance of override data.
override request id for an override request
proto field path which is the string representation of a field. example: correlated.primary_entity_id would be primary_entity_id in correlated component
new field value corresponding to field path. In the shape of an empty entity with only the changed value. example: entity: { mil_view: { disposition: Disposition_DISPOSITION_HOSTILE } }
A Globally Unique Identifier (GUID) for your entity. If this field is empty, the Entity Manager API automatically generates an ID when it creates the entity.
A human-readable entity description that's helpful for debugging purposes and human traceability. If this field is empty, the Entity Manager API generates one for you.
Indicates the entity is active and should have a lifecycle state of CREATE or UPDATE. Set this field to true when publishing an entity.
The time when the entity was first known to the entity producer. If this field is empty, the Entity Manager API uses the current timestamp of when the entity is first received. For example, when a drone is first powered on, it might report its startup time as the created time. The timestamp doesn't change for the lifetime of an entity.
Future time that expires an entity and updates the is_live flag. For entities that are constantly updating, the expiry time also updates. In some cases, this may differ from is_live. Example: Entities with tasks exported to an external system must remain active even after they expire. This field is required when publishing a prepopulated entity. The expiry time must be in the future, but less than 30 days from the current time.
Human-readable descriptions of what the entity is currently doing.
Geospatial data related to the entity, including its position, kinematics, and orientation.
Indicates uncertainty of the entity's position and kinematics.
Geospatial representation of the entity, including entities that cover an area rather than a fixed point.
Additional details on what the geospatial area or point represents, along with visual display details.
Entity name displayed in the Lattice UI side panel. Also includes identifiers that other systems can use to reference the same entity.
If this entity is tracked by another entity, this component contains data related to how it's being tracked.
If this entity has been correlated or decorrelated to another one, this component contains information on the correlation or decorrelation.
View of the entity.
Ontology defines an entity's categorization in Lattice, and improves data retrieval and integration. Builds a standardized representation of the entity.
Details an entity's available sensors.
Details an entity's available payloads.
Details the entity's power source.
The primary data source provenance for this entity.
Provenance of override data.
Describes an entity's specific characteristics and the operations that can be performed on the entity. For example, "simulated" informs the operator that the entity is from a simulation, and "deletable" informs the operator (and system) that the delete operation is valid against the entity.
The prioritization associated with an entity, such as if it's a threat or a high-value target.
Describes an entity's signal characteristics, primarily used when an entity is a signal of interest.
A message describing any transponder codes associated with Mode 1, 2, 3, 4, 5, S interrogations. These are related to ADS-B modes.
Describes an entity's security classification levels at an overall classification level and on a per field level.
A catalog of tasks that can be performed by an entity.
The relationships between this entity and other entities in the common operational picture (COP).
Visual details associated with the display of an entity in the client.
Physical dimensions of the entity.
Additional information about an entity's route.
Schedules associated with this entity.
Health metrics or connection status reported by the entity.
Details for the group associated with this entity.
Contains relevant supply information for the entity, such as fuel.
Orbit information for space objects.
status of the override
the override was applied to the entity.
the override is pending action.
the override has been timed out.
the override has been rejected
The override is pending deletion.
Name of the integration that produced this entity
Source data type of this entity. Examples: ADSB, Link16, etc.
An ID that allows an element from a source to be uniquely identified
The time, according to the source system, that the data in the entity was last modified. Generally, this should be the time that the source-reported time of validity of the data in the entity. This field must be updated with every change to the entity or else Entity Manager will discard the update.
Description of the modification source. In the case of a user this is the email address.
The type of the override, defined by the stage of the entity lifecycle that the entity was in when the override was requested.
The override type value was not set. This value is interpreted as OVERRIDE_TYPE_LIVE for backward compatibility.
Override was requested when the entity was live according to the Entity Manager instance that handled the request.
Override was requested after the entity expired according to the Entity Manager instance that handled the request.
Timestamp of the override request. The timestamp is generated by the Entity Manager instance that receives the request.
Describes an entity's specific characteristics and the operations that can be performed on the entity. For example, "simulated" informs the operator that the entity is from a simulation, and "deletable" informs the operator (and system) that the delete operation is valid against the entity.
Indicates the Entity should be egressed to external sources. Integrations choose how the egressing happens (e.g. if an Entity needs fuzzing).
A signal of arbitrary importance such that the entity should be globally marked for all users
The prioritization associated with an entity, such as if it's a threat or a high-value target.
Describes the target priority in relation to high value target lists.
Indicates whether the target matches any description from a high value target list.
The priority associated with the target. If the target's description appears on multiple high value target lists, the priority will be a reflection of the highest priority of all of those list's target description.
A lower value indicates the target is of a higher priority, with 1 being the highest possible priority. A value of 0 indicates there is no priority associated with this target.
All of the high value target descriptions that the target matches against.
The ID of the high value target list that matches the target description.
The ID of the specific high value target description within a high value target list that was matched against. The ID is considered to be a globally unique identifier across all high value target IDs.
Indicates whether the target is a 'High Payoff Target'. Targets can be one or both of high value and high payoff.
Describes whether the entity should be treated as a threat
Indicates that the entity has been determined to be a threat.
Describes an entity's signal characteristics, primarily used when an entity is a signal of interest.
Indicates a frequency of a signal (Hz) with its standard deviation.
The value of the measurement.
Estimated one standard deviation in same unit as the value.
Indicates the lowest measured frequency of a signal (Hz).
Indicates a frequency of a signal (Hz) with its standard deviation.
Indicates the maximum measured frequency of a signal (Hz).
Indicates a frequency of a signal (Hz) with its standard deviation.
Indicates the bandwidth of a signal (Hz).
Indicates the signal to noise (SNR) of this signal.
The direction pointing from this entity to the detection
Origin (LLA) and attitude (relative to ENU) of a ray pointing towards the detection. The attitude represents a forward-left-up (FLU) frame where the x-axis (1, 0, 0) is pointing towards the target.
Bearing/elevation covariance matrix where bearing is defined in radians CCW+ about the z-axis from the x-axis of FLU frame and elevation is positive down from the FL/XY plane. mxx = bearing variance in rad^2 mxy = bearing/elevation covariance in rad^2 myy = elevation variance in rad^2
The estimated distance of the detection
The value of the measurement.
Estimated one standard deviation in same unit as the value.
The maximum distance of the detection
The value of the measurement.
Estimated one standard deviation in same unit as the value.
Emitter notations associated with this entity.
confidence as a percentage that the emitter notation in this component is accurate
length in time of a single pulse
length in time between the start of two pulses
The value of the measurement.
Estimated one standard deviation in same unit as the value.
describes how a signal is observing the environment
A message describing any transponder codes associated with Mode 1, 2, 3, 4, 5, S interrogations. These are related to ADS-B modes.
The mode 1 code assigned to military assets.
The Mode 2 code assigned to military assets.
The Mode 3 code assigned by ATC to the asset.
The validity of the response from the Mode 4 interrogation.
Note that INTERROGATION_INVALID indicates that the target has not been interrogated.
The Mode 5 transponder codes.
The validity of the response from the Mode 5 interrogation.
Note that INTERROGATION_INVALID indicates that the target has not been interrogated.
The Mode 5 code assigned to military assets.
The Mode 5 platform identification code.
The Mode S transponder codes.
Mode S identifier which comprises of 8 alphanumeric characters.
The Mode S ICAO aircraft address. Expected values are between 1 and 16777214 decimal. The Mode S address is considered unique.
Describes an entity's security classification levels at an overall classification level and on a per field level.
The default classification information which should be assumed to apply to everything in the entity unless a specific field level classification is present.
Classification level to be applied to the information in question.
Caveats that may further restrict how the information can be disseminated.
The set of individual field classification information which should always precedence over the default classification information.
Proto field path which is the string representation of a field.
example: signal.bandwidth_hz would be bandwidth_hz in the signal component
The information which makes up the field level classification marking.
Classification level to be applied to the information in question.
Caveats that may further restrict how the information can be disseminated.
A catalog of tasks that can be performed by an entity.
Url path must be prefixed with type.googleapis.com/.
The relationships between this entity and other entities in the common operational picture (COP).
The entity ID to which this entity is related.
A unique identifier for this relationship. Allows removing or updating relationships.
The relationship type
Visual details associated with the display of an entity in the client.
The range rings to display around an entity.
The minimum range ring distance, specified in meters.
The maximum range ring distance, specified in meters.
The count of range rings.
The color of range rings, specified in hex string.
The amount of red in the color as a value in the interval [0, 1].
The amount of green in the color as a value in the interval [0, 1].
The amount of blue in the color as a value in the interval [0, 1].
The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation:
pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
Physical dimensions of the entity.
Length of the entity in meters
Additional information about an entity's route.
Free form text giving the name of the entity's destination
Estimated time of arrival at destination
Schedules associated with this entity.
expression that represents this schedule's "ON" state
in UTC, describes when and at what cadence this window starts, in the quartz flavor of cron
examples: This schedule is begins at 7:00:00am UTC everyday between Monday and Friday 0 0 7 ? * MON-FRI * This schedule begins every 5 minutes starting at 12:00:00pm UTC until 8:00:00pm UTC everyday 0 0/5 12-20 * * ? * This schedule begins at 12:00:00pm UTC on March 2nd 2023 0 0 12 2 3 ? 2023
describes the duration
A unique identifier for this schedule.
The schedule type
Health metrics or connection status reported by the entity.
Status indicating whether the entity is able to communicate with Entity Manager.
Top-level health status; typically a roll-up of individual component healths.
Indicates that the component is operating as intended.
Indicates that the component is at risk of transitioning into a HEALTH_STATUS_FAIL state or that the component is operating in a degraded state.
Indicates that the component is not functioning as intended.
Indicates that the component is offline.
Indicates that the component is not yet functioning, but it is transitioning into a HEALTH_STATUS_HEALTHY state. A component should only report this state temporarily.
Health of individual components running on this Entity.
Consistent internal ID for this component.
Display name for this component.
Health for this component.
Indicates that the component is operating as intended.
Indicates that the component is at risk of transitioning into a HEALTH_STATUS_FAIL state or that the component is operating in a degraded state.
Indicates that the component is not functioning as intended.
Indicates that the component is offline.
Indicates that the component is not yet functioning, but it is transitioning into a HEALTH_STATUS_HEALTHY state. A component should only report this state temporarily.
Human-readable describing the component state. These messages should be understandable by end users.
The status associated with this message.
Indicates that the component is operating as intended.
Indicates that the component is at risk of transitioning into a HEALTH_STATUS_FAIL state or that the component is operating in a degraded state.
Indicates that the component is not functioning as intended.
Indicates that the component is offline.
Indicates that the component is not yet functioning, but it is transitioning into a HEALTH_STATUS_HEALTHY state. A component should only report this state temporarily.
The human-readable content of the message.
The last update time for this specific component. If this timestamp is unset, the data is assumed to be most recent
The update time for the top-level health information. If this timestamp is unset, the data is assumed to be most recent
Active alerts indicate a critical change in system state sent by the asset that must be made known to an operator or consumer of the common operating picture. Alerts are different from ComponentHealth messages--an active alert does not necessarily indicate a component is in an unhealthy state. For example, an asset may trigger an active alert based on fuel levels running low. Alerts should be removed from this list when their conditions are cleared. In other words, only active alerts should be reported here.
Short, machine-readable code that describes this alert. This code is intended to provide systems off-asset with a lookup key to retrieve more detailed information about the alert.
Human-readable description of this alert. The description is intended for display in the UI for human understanding and should not be used for machine processing. If the description is fixed and the vehicle controller provides no dynamic substitutions, then prefer lookup based on alert_code.
Alert level (Warning, Caution, or Advisory).
For conditions that require awareness and may require subsequent response.
For conditions that require immediate awareness and subsequent response.
For conditions that require immediate awareness and response.
Time at which this alert was activated.
Set of conditions which have activated this alert.
Short, machine-readable code that describes this condition. This code is intended to provide systems off-asset with a lookup key to retrieve more detailed information about the condition.
Human-readable description of this condition. The description is intended for display in the UI for human understanding and should not be used for machine processing. If the description is fixed and the vehicle controller provides no dynamic substitutions, then prefer lookup based on condition_code.
Details for the group associated with this entity.
Contains relevant supply information for the entity, such as fuel.
unique fuel identifier
long form name of the fuel source.
timestamp the information was reported
amount of gallons on hand
how much the asset is allowed to have available (in gallons)
minimum required for operations (in gallons)
fuel in a single asset may have different levels of classification use case: fuel for a SECRET asset while diesel fuel may be UNCLASSIFIED
The default classification information which should be assumed to apply to everything in the entity unless a specific field level classification is present.
The set of individual field classification information which should always precedence over the default classification information.
source of information
Orbit information for space objects.
Orbit Mean Elements data, analogous to the Orbit Mean Elements Message in CCSDS 502.0-B-3
Creation date/time in UTC
Creating agency or operator
ID that uniquely identifies a message from a given originator.
Reference frame, assumed to be Earth-centered
Reference frame epoch in UTC - mandatory only if not intrinsic to frame definition
UTC time of validity
Preferred: semi major axis in kilometers
If using SGP/SGP4, provide the Keplerian Mean Motion in revolutions per day
Angle of inclination in deg
Right ascension of the ascending node in deg
Argument of pericenter in deg
Mean anomaly in deg
Optional: gravitational coefficient (Gravitational Constant x central mass) in kg^3 / s^2
Integer specifying TLE ephemeris type
User-defined free-text message classification/caveats of this TLE
Norad catalog number: integer up to nine digits.
Optional: revolution number
Drag parameter for SGP-4 in units 1 / Earth radii
Drag parameter for SGP4-XP in units m^2 / kg
First time derivative of mean motion in rev / day^2
Second time derivative of mean motion in rev / day^3. For use with SGP or PPT3.
Solar radiation pressure coefficient A_gamma / m in m^2 / kg. For use with SGP4-XP.
The timestamp at which the heartbeat message was sent.