@foxglove/schemas 1.7.2 → 1.8.0

package/dist/jsonschema/index.js

@@ -1,7 +1,7 @@
 "use strict";
 // Generated by https://github.com/foxglove/foxglove-sdk
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Vector3 = exports.Vector2 = exports.TriangleListPrimitive = exports.TextPrimitive = exports.TextAnnotation = exports.SpherePrimitive = exports.RawImage = exports.RawAudio = exports.Quaternion = exports.PosesInFrame = exports.PoseInFrame = exports.Pose = exports.PointsAnnotation = exports.PointCloud = exports.Point3 = exports.Point2 = exports.PackedElementField = exports.ModelPrimitive = exports.SceneUpdate = exports.SceneEntity = exports.SceneEntityDeletion = exports.Log = exports.LocationFix = exports.LinePrimitive = exports.LaserScan = exports.KeyValuePair = exports.ImageAnnotations = exports.Grid = exports.GeoJSON = exports.FrameTransforms = exports.FrameTransform = exports.CubePrimitive = exports.CylinderPrimitive = exports.CompressedVideo = exports.CompressedImage = exports.Color = exports.CircleAnnotation = exports.CameraCalibration = exports.ArrowPrimitive = void 0;
+exports.Time = exports.Vector3 = exports.Vector2 = exports.TriangleListPrimitive = exports.Timestamp = exports.TextPrimitive = exports.TextAnnotation = exports.SpherePrimitive = exports.RawImage = exports.RawAudio = exports.Quaternion = exports.PosesInFrame = exports.PoseInFrame = exports.Pose = exports.PointsAnnotation = exports.PointCloud = exports.Point3 = exports.Point2 = exports.PackedElementField = exports.ModelPrimitive = exports.SceneUpdate = exports.SceneEntity = exports.SceneEntityDeletion = exports.Log = exports.LocationFixes = exports.LocationFix = exports.LinePrimitive = exports.LaserScan = exports.KeyValuePair = exports.ImageAnnotations = exports.VoxelGrid = exports.Grid = exports.GeoJSON = exports.FrameTransforms = exports.FrameTransform = exports.Duration = exports.CubePrimitive = exports.CylinderPrimitive = exports.CompressedVideo = exports.CompressedImage = exports.Color = exports.CircleAnnotation = exports.CameraCalibration = exports.ArrowPrimitive = void 0;
 exports.ArrowPrimitive = {
     "title": "foxglove.ArrowPrimitive",
     "description": "A primitive representing an arrow",
@@ -136,7 +136,7 @@ exports.CameraCalibration = {
         },
         "distortion_model": {
             "type": "string",
-            "description": "Name of distortion model\n\nSupported parameters: `plumb_bob` (k1, k2, p1, p2, k3), `rational_polynomial` (k1, k2, p1, p2, k3, k4, k5, k6), and `kannala_brandt` (k1, k2, k3, k4). `plumb_bob` and `rational_polynomial` models are based on the pinhole model [OpenCV's](https://docs.opencv.org/4.11.0/d9/d0c/group__calib3d.html) [pinhole camera model](https://en.wikipedia.org/wiki/Distortion_%28optics%29#Software_correction). The `kannala_brandt` model is matches the [OpenvCV fisheye](https://docs.opencv.org/4.11.0/db/d58/group__calib3d__fisheye.html) model."
+            "description": "Name of distortion model\n\nSupported parameters: `plumb_bob` (k1, k2, p1, p2, k3), `rational_polynomial` (k1, k2, p1, p2, k3, k4, k5, k6), and `kannala_brandt` (k1, k2, k3, k4). `plumb_bob` and `rational_polynomial` models are based on the pinhole model [OpenCV's](https://docs.opencv.org/4.11.0/d9/d0c/group__calib3d.html) [pinhole camera model](https://en.wikipedia.org/wiki/Distortion_%28optics%29#Software_correction). The `kannala_brandt` model matches the [OpenvCV fisheye](https://docs.opencv.org/4.11.0/db/d58/group__calib3d__fisheye.html) model."
         },
         "D": {
             "type": "array",
@@ -571,6 +571,23 @@ exports.CubePrimitive = {
         }
     }
 };
+exports.Duration = {
+    "title": "foxglove.Duration",
+    "description": "A duration of time, composed of seconds and nanoseconds",
+    "$comment": "Generated by https://github.com/foxglove/foxglove-sdk",
+    "type": "object",
+    "properties": {
+        "sec": {
+            "type": "integer",
+            "description": "The number of seconds in the duration"
+        },
+        "nsec": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "The number of nanoseconds in the positive direction"
+        }
+    }
+};
 exports.FrameTransform = {
     "title": "foxglove.FrameTransform",
     "description": "A transform between two reference frames in 3D space",
@@ -921,7 +938,204 @@ exports.Grid = {
         "data": {
             "type": "string",
             "contentEncoding": "base64",
-            "description": "Grid cell data, interpreted using `fields`, in row-major (y-major) order"
+            "description": "Grid cell data, interpreted using `fields`, in row-major (y-major) order.\n For the data element starting at byte offset i, the coordinates of its corner closest to the origin will be:\n y = (i / cell_stride) % row_stride * cell_size.y\n x = i % cell_stride * cell_size.x"
+        }
+    }
+};
+exports.VoxelGrid = {
+    "title": "foxglove.VoxelGrid",
+    "description": "A 3D grid of data",
+    "$comment": "Generated by https://github.com/foxglove/foxglove-sdk",
+    "type": "object",
+    "properties": {
+        "timestamp": {
+            "type": "object",
+            "title": "time",
+            "properties": {
+                "sec": {
+                    "type": "integer",
+                    "minimum": 0
+                },
+                "nsec": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "maximum": 999999999
+                }
+            },
+            "description": "Timestamp of grid"
+        },
+        "frame_id": {
+            "type": "string",
+            "description": "Frame of reference"
+        },
+        "pose": {
+            "title": "foxglove.Pose",
+            "description": "Origin of grid's corner relative to frame of reference",
+            "type": "object",
+            "properties": {
+                "position": {
+                    "title": "foxglove.Vector3",
+                    "description": "Point denoting position in 3D space",
+                    "type": "object",
+                    "properties": {
+                        "x": {
+                            "type": "number",
+                            "description": "x coordinate length"
+                        },
+                        "y": {
+                            "type": "number",
+                            "description": "y coordinate length"
+                        },
+                        "z": {
+                            "type": "number",
+                            "description": "z coordinate length"
+                        }
+                    }
+                },
+                "orientation": {
+                    "title": "foxglove.Quaternion",
+                    "description": "Quaternion denoting orientation in 3D space",
+                    "type": "object",
+                    "properties": {
+                        "x": {
+                            "type": "number",
+                            "description": "x value"
+                        },
+                        "y": {
+                            "type": "number",
+                            "description": "y value"
+                        },
+                        "z": {
+                            "type": "number",
+                            "description": "z value"
+                        },
+                        "w": {
+                            "type": "number",
+                            "description": "w value"
+                        }
+                    }
+                }
+            }
+        },
+        "row_count": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "Number of grid rows"
+        },
+        "column_count": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "Number of grid columns"
+        },
+        "cell_size": {
+            "title": "foxglove.Vector3",
+            "description": "Size of single grid cell along x, y, and z axes, relative to `pose`",
+            "type": "object",
+            "properties": {
+                "x": {
+                    "type": "number",
+                    "description": "x coordinate length"
+                },
+                "y": {
+                    "type": "number",
+                    "description": "y coordinate length"
+                },
+                "z": {
+                    "type": "number",
+                    "description": "z coordinate length"
+                }
+            }
+        },
+        "slice_stride": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "Number of bytes between depth slices in `data`"
+        },
+        "row_stride": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "Number of bytes between rows in `data`"
+        },
+        "cell_stride": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "Number of bytes between cells within a row in `data`"
+        },
+        "fields": {
+            "type": "array",
+            "items": {
+                "title": "foxglove.PackedElementField",
+                "description": "A field present within each element in a byte array of packed elements.",
+                "type": "object",
+                "properties": {
+                    "name": {
+                        "type": "string",
+                        "description": "Name of the field"
+                    },
+                    "offset": {
+                        "type": "integer",
+                        "minimum": 0,
+                        "description": "Byte offset from start of data buffer"
+                    },
+                    "type": {
+                        "title": "foxglove.NumericType",
+                        "description": "Type of data in the field. Integers are stored using little-endian byte order.",
+                        "oneOf": [
+                            {
+                                "title": "UNKNOWN",
+                                "const": 0,
+                                "description": "Unknown numeric type"
+                            },
+                            {
+                                "title": "UINT8",
+                                "const": 1,
+                                "description": "Unsigned 8-bit integer"
+                            },
+                            {
+                                "title": "INT8",
+                                "const": 2,
+                                "description": "Signed 8-bit integer"
+                            },
+                            {
+                                "title": "UINT16",
+                                "const": 3,
+                                "description": "Unsigned 16-bit integer"
+                            },
+                            {
+                                "title": "INT16",
+                                "const": 4,
+                                "description": "Signed 16-bit integer"
+                            },
+                            {
+                                "title": "UINT32",
+                                "const": 5,
+                                "description": "Unsigned 32-bit integer"
+                            },
+                            {
+                                "title": "INT32",
+                                "const": 6,
+                                "description": "Signed 32-bit integer"
+                            },
+                            {
+                                "title": "FLOAT32",
+                                "const": 7,
+                                "description": "32-bit floating-point number"
+                            },
+                            {
+                                "title": "FLOAT64",
+                                "const": 8,
+                                "description": "64-bit floating-point number"
+                            }
+                        ]
+                    }
+                }
+            },
+            "description": "Fields in `data`. `red`, `green`, `blue`, and `alpha` are optional for customizing the grid's color."
+        },
+        "data": {
+            "type": "string",
+            "contentEncoding": "base64",
+            "description": "Grid cell data, interpreted using `fields`, in depth-major, row-major (Z-Y-X) order.\n For the data element starting at byte offset i, the coordinates of its corner closest to the origin will be:\n z = i / slice_stride * cell_size.z\n y = (i % slice_stride) / row_stride * cell_size.y\n x = (i % row_stride) / cell_stride * cell_size.x"
         }
     }
 };
@@ -1633,6 +1847,138 @@ exports.LocationFix = {
                     "description": "Position covariance of the fix is known"
                 }
             ]
+        },
+        "color": {
+            "title": "foxglove.Color",
+            "description": "Color used to visualize the location",
+            "type": "object",
+            "properties": {
+                "r": {
+                    "type": "number",
+                    "description": "Red value between 0 and 1"
+                },
+                "g": {
+                    "type": "number",
+                    "description": "Green value between 0 and 1"
+                },
+                "b": {
+                    "type": "number",
+                    "description": "Blue value between 0 and 1"
+                },
+                "a": {
+                    "type": "number",
+                    "description": "Alpha value between 0 and 1"
+                }
+            }
+        }
+    }
+};
+exports.LocationFixes = {
+    "title": "foxglove.LocationFixes",
+    "description": "A group of LocationFix messages",
+    "$comment": "Generated by https://github.com/foxglove/foxglove-sdk",
+    "type": "object",
+    "properties": {
+        "fixes": {
+            "type": "array",
+            "items": {
+                "title": "foxglove.LocationFix",
+                "description": "A navigation satellite fix for any Global Navigation Satellite System",
+                "type": "object",
+                "properties": {
+                    "timestamp": {
+                        "type": "object",
+                        "title": "time",
+                        "properties": {
+                            "sec": {
+                                "type": "integer",
+                                "minimum": 0
+                            },
+                            "nsec": {
+                                "type": "integer",
+                                "minimum": 0,
+                                "maximum": 999999999
+                            }
+                        },
+                        "description": "Timestamp of the message"
+                    },
+                    "frame_id": {
+                        "type": "string",
+                        "description": "Frame for the sensor. Latitude and longitude readings are at the origin of the frame."
+                    },
+                    "latitude": {
+                        "type": "number",
+                        "description": "Latitude in degrees"
+                    },
+                    "longitude": {
+                        "type": "number",
+                        "description": "Longitude in degrees"
+                    },
+                    "altitude": {
+                        "type": "number",
+                        "description": "Altitude in meters"
+                    },
+                    "position_covariance": {
+                        "type": "array",
+                        "items": {
+                            "type": "number"
+                        },
+                        "minItems": 9,
+                        "maxItems": 9,
+                        "description": "Position covariance (m^2) defined relative to a tangential plane through the reported position. The components are East, North, and Up (ENU), in row-major order."
+                    },
+                    "position_covariance_type": {
+                        "title": "foxglove.PositionCovarianceType",
+                        "description": "If `position_covariance` is available, `position_covariance_type` must be set to indicate the type of covariance.",
+                        "oneOf": [
+                            {
+                                "title": "UNKNOWN",
+                                "const": 0,
+                                "description": "Unknown position covariance type"
+                            },
+                            {
+                                "title": "APPROXIMATED",
+                                "const": 1,
+                                "description": "Position covariance is approximated"
+                            },
+                            {
+                                "title": "DIAGONAL_KNOWN",
+                                "const": 2,
+                                "description": "Position covariance is per-axis, so put it along the diagonal"
+                            },
+                            {
+                                "title": "KNOWN",
+                                "const": 3,
+                                "description": "Position covariance of the fix is known"
+                            }
+                        ]
+                    },
+                    "color": {
+                        "title": "foxglove.Color",
+                        "description": "Color used to visualize the location",
+                        "type": "object",
+                        "properties": {
+                            "r": {
+                                "type": "number",
+                                "description": "Red value between 0 and 1"
+                            },
+                            "g": {
+                                "type": "number",
+                                "description": "Green value between 0 and 1"
+                            },
+                            "b": {
+                                "type": "number",
+                                "description": "Blue value between 0 and 1"
+                            },
+                            "a": {
+                                "type": "number",
+                                "description": "Alpha value between 0 and 1"
+                            }
+                        }
+                    }
+                }
+            },
+            "description": "An array of location fixes"
         }
     }
 };
@@ -4672,26 +5018,26 @@ exports.RawImage = {
         "width": {
             "type": "integer",
             "minimum": 0,
-            "description": "Image width"
+            "description": "Image width in pixels"
         },
         "height": {
             "type": "integer",
             "minimum": 0,
-            "description": "Image height"
+            "description": "Image height in pixels"
         },
         "encoding": {
             "type": "string",
-            "description": "Encoding of the raw image data\n\nSupported values: `8UC1`, `8UC3`, `16UC1` (little endian), `32FC1` (little endian), `bayer_bggr8`, `bayer_gbrg8`, `bayer_grbg8`, `bayer_rggb8`, `bgr8`, `bgra8`, `mono8`, `mono16`, `rgb8`, `rgba8`, `uyvy` or `yuv422`, `yuyv` or `yuv422_yuy2`"
+            "description": "Encoding of the raw image data. See the `data` field description for supported values."
         },
         "step": {
             "type": "integer",
             "minimum": 0,
-            "description": "Byte length of a single row"
+            "description": "Byte length of a single row. This is usually some multiple of `width` depending on the encoding, but can be greater to incorporate padding."
         },
         "data": {
             "type": "string",
             "contentEncoding": "base64",
-            "description": "Raw image data"
+            "description": "Raw image data.\n\nFor each `encoding` value, the `data` field contains image pixel data serialized as follows:\n\n- `yuv422` or `uyvy`:\n  - Pixel colors are decomposed into [Y'UV](https://en.wikipedia.org/wiki/Y%E2%80%B2UV) channels.\n  - Pixel channel values are represented as unsigned 8-bit integers.\n  - U and V values are shared between horizontal pairs of pixels. Each pair of output pixels is serialized as [U, Y1, V, Y2].\n  - `step` must be greater than or equal to `width` * 2.\n- `yuv422_yuy2` or  `yuyv`:\n  - Pixel colors are decomposed into [Y'UV](https://en.wikipedia.org/wiki/Y%E2%80%B2UV) channels.\n  - Pixel channel values are represented as unsigned 8-bit integers.\n  - U and V values are shared between horizontal pairs of pixels. Each pair of output pixels is encoded as [Y1, U, Y2, V].\n  - `step` must be greater than or equal to `width` * 2.\n- `rgb8`:\n  - Pixel colors are decomposed into Red, Green, and Blue channels.\n  - Pixel channel values are represented as unsigned 8-bit integers.\n  - Each output pixel is serialized as [R, G, B].\n  - `step` must be greater than or equal to `width` * 3.\n- `rgba8`:\n  - Pixel colors are decomposed into Red, Green, Blue, and Alpha channels.\n  - Pixel channel values are represented as unsigned 8-bit integers.\n  - Each output pixel is serialized as [R, G, B, Alpha].\n  - `step` must be greater than or equal to `width` * 4.\n- `bgr8` or `8UC3`:\n  - Pixel colors are decomposed into Red, Blue, Green, and Alpha channels.\n  - Pixel channel values are represented as unsigned 8-bit integers.\n  - Each output pixel is serialized as [B, G, R].\n  - `step` must be greater than or equal to `width` * 3.\n- `bgra8`:\n  - Pixel colors are decomposed into Blue, Green, Red, and Alpha channels.\n  - Pixel channel values are represented as unsigned 8-bit integers.\n  - Each output pixel is encoded as [B, G, R, Alpha].\n  - `step` must be greater than or equal to `width` * 4.\n- `32FC1`:\n  - Pixel brightness is represented as a single-channel, 32-bit little-endian IEEE 754 floating-point value, ranging from 0.0 (black) to 1.0 (white).\n  - `step` must be greater than or equal to `width` * 4.\n- `bayer_rggb8`, `bayer_bggr8`, `bayer_rggb8`, `bayer_gbrg8`, or `bayer_grgb8`:\n  - Pixel colors are decomposed into Red, Blue and Green channels.\n  - Pixel channel values are represented as unsigned 8-bit integers, and serialized in a 2x2 bayer filter pattern.\n  - The order of the four letters after `bayer_` determine the layout, so for `bayer_wxyz8` the pattern is:\n  ```plaintext\n  w | x\n  - + -\n  y | z\n  ```\n  - `step` must be greater than or equal to `width`.\n- `mono8` or `8UC1`:\n  - Pixel brightness is represented as unsigned 8-bit integers.\n  - `step` must be greater than or equal to `width`.\n- `mono16` or `16UC1`:\n  - Pixel brightness is represented as 16-bit unsigned little-endian integers. Rendering of these values is controlled in [Image panel color mode settings](https://docs.foxglove.dev/docs/visualization/panels/image#general).\n  - `step` must be greater than or equal to `width` * 2.\n"
         }
     }
 };
@@ -4983,6 +5329,24 @@ exports.TextPrimitive = {
         }
     }
 };
+exports.Timestamp = {
+    "title": "foxglove.Timestamp",
+    "description": "A timestamp composed of seconds and nanoseconds",
+    "$comment": "Generated by https://github.com/foxglove/foxglove-sdk",
+    "type": "object",
+    "properties": {
+        "sec": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "The number of seconds since a user-defined epoch"
+        },
+        "nsec": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "The number of nanoseconds since the sec value"
+        }
+    }
+};
 exports.TriangleListPrimitive = {
     "title": "foxglove.TriangleListPrimitive",
     "description": "A primitive representing a set of triangles or a surface tiled by triangles",
@@ -5157,4 +5521,5 @@ exports.Vector3 = {
         }
     }
 };
+exports.Time = exports.Timestamp;
 //# sourceMappingURL=index.js.map