From 40756370074160ac8619c529b464f0571cafe7e5 Mon Sep 17 00:00:00 2001 From: Jacob Bandes-Storch Date: Mon, 11 Mar 2024 16:45:56 -0700 Subject: [PATCH] Update links and studio references --- .vscode/settings.json | 8 ++------ README.md | 6 +++--- .../__snapshots__/exportTypeScriptSchemas.test.ts.snap | 2 +- internal/generateMarkdown.ts | 2 +- internal/generateRos.ts | 4 ++-- internal/generateTypeScript.ts | 2 +- internal/schemas.ts | 2 +- python/foxglove-schemas-flatbuffer/README.md | 2 +- python/foxglove-schemas-protobuf/README.md | 2 +- ros_foxglove_msgs/package.xml | 2 +- ros_foxglove_msgs/ros1/CompressedVideo.msg | 2 +- ros_foxglove_msgs/ros2/CompressedVideo.msg | 2 +- schemas/README.md | 4 ++-- schemas/flatbuffer/CompressedVideo.fbs | 2 +- schemas/jsonschema/CompressedVideo.json | 2 +- schemas/jsonschema/index.ts | 2 +- schemas/omgidl/foxglove/CompressedVideo.idl | 2 +- schemas/proto/foxglove/CompressedVideo.proto | 2 +- schemas/ros1/CompressedVideo.msg | 2 +- schemas/ros2/CompressedVideo.msg | 2 +- schemas/typescript/CompressedVideo.ts | 2 +- 21 files changed, 26 insertions(+), 30 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 474b866b..41cc3e54 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,7 +1,7 @@ // -*- jsonc -*- { "editor.codeActionsOnSave": { - "source.fixAll.eslint": true + "source.fixAll.eslint": "explicit" }, "editor.defaultFormatter": "esbenp.prettier-vscode", "editor.formatOnSave": true, @@ -18,12 +18,8 @@ }, "jest.jestCommandLine": "yarn test", - "python.formatting.provider": "black", "python.analysis.typeCheckingMode": "strict", - "python.linting.flake8Enabled": true, - "python.linting.enabled": true, - "python.linting.flake8Args": ["--config", "python/.flake8"], "[python]": { - "editor.defaultFormatter": "ms-python.python" + "editor.defaultFormatter": "ms-python.black-formatter" } } diff --git a/README.md b/README.md index 6282a226..01687b8e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # @foxglove/schemas -Message schemas supported by [Foxglove Studio](https://studio.foxglove.dev) +Message schemas supported by [Foxglove](https://foxglove.dev) | Language/Framework | Package name | Version | | --------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -11,11 +11,11 @@ Message schemas supported by [Foxglove Studio](https://studio.foxglove.dev) ## Introduction -See [Foxglove Schemas documentation](https://foxglove.dev/docs/studio/messages). +See [Foxglove Schemas documentation](https://docs.foxglove.dev/docs/visualization/message-schemas/introduction). The [schemas](./schemas) folder contains type definitions generated for ROS 1, ROS 2, Protobuf, JSON Schema, TypeScript, and OMG IDL. -These schemas can be used in [MCAP](https://github.com/foxglove/mcap) files or [Foxglove WebSocket](https://github.com/foxglove/ws-protocol) servers to take advantage of Foxglove Studio's visualizations. +These schemas can be used in [MCAP](https://github.com/foxglove/mcap) files or [Foxglove WebSocket](https://github.com/foxglove/ws-protocol) servers to take advantage of Foxglove's visualizations. ## License diff --git a/internal/__snapshots__/exportTypeScriptSchemas.test.ts.snap b/internal/__snapshots__/exportTypeScriptSchemas.test.ts.snap index 2c143dd2..14bce990 100644 --- a/internal/__snapshots__/exportTypeScriptSchemas.test.ts.snap +++ b/internal/__snapshots__/exportTypeScriptSchemas.test.ts.snap @@ -200,7 +200,7 @@ export type CompressedVideo = { /** * Compressed video frame data. * - * For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead. + * For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead. */ data: Uint8Array; diff --git a/internal/generateMarkdown.ts b/internal/generateMarkdown.ts index 9c187187..f2054aed 100644 --- a/internal/generateMarkdown.ts +++ b/internal/generateMarkdown.ts @@ -11,7 +11,7 @@ export function generateMarkdown( `\ # Foxglove schemas -See [Foxglove Schemas documentation](https://foxglove.dev/docs/studio/messages). +See [Foxglove Schemas documentation](https://docs.foxglove.dev/docs/visualization/message-schemas/introduction). All schemas are generated from [schemas.ts](/internal/schemas.ts).`, diff --git a/internal/generateRos.ts b/internal/generateRos.ts index 0ceeb91e..c2d0e47d 100644 --- a/internal/generateRos.ts +++ b/internal/generateRos.ts @@ -127,8 +127,8 @@ export function generateRosMsgDefinition( let fieldType: string; switch (field.type.type) { case "enum": { - // Add enum constants preceding the field so that Studio can pick them up: - // https://foxglove.dev/docs/studio/annotating-data + // Add enum constants preceding the field so that Foxglove can pick them up: + // https://docs.foxglove.dev/docs/visualization/annotate-ros-enum-fields const enumName = field.type.enum.name; const valueType = "uint8"; fieldType = valueType; diff --git a/internal/generateTypeScript.ts b/internal/generateTypeScript.ts index 4634a154..5853d676 100644 --- a/internal/generateTypeScript.ts +++ b/internal/generateTypeScript.ts @@ -44,7 +44,7 @@ export const DURATION_TS = `export type Duration = { export type GenerateTypeScriptOptions = { /** * Include TypedArray types on numeric array fields, e.g. `number[] | Uint32Array`. Used by - * foxglove/studio to accept TypedArrays for user script outputs. + * Foxglove to accept TypedArrays for user script outputs. */ includeTypedArrays?: boolean; }; diff --git a/internal/schemas.ts b/internal/schemas.ts index 9aa07085..f0a44268 100644 --- a/internal/schemas.ts +++ b/internal/schemas.ts @@ -811,7 +811,7 @@ const CompressedVideo: FoxgloveMessageSchema = { name: "data", type: { type: "primitive", name: "bytes" }, description: - "Compressed video frame data.\n\nFor packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead.", + "Compressed video frame data.\n\nFor packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead.", }, { name: "format", diff --git a/python/foxglove-schemas-flatbuffer/README.md b/python/foxglove-schemas-flatbuffer/README.md index 41b93421..79c1b04a 100644 --- a/python/foxglove-schemas-flatbuffer/README.md +++ b/python/foxglove-schemas-flatbuffer/README.md @@ -1,6 +1,6 @@ # Foxglove Schemas (Flatbuffer) -This package provides [Flatbuffer](https://google.github.io/flatbuffers/) classes for [Foxglove Schemas](https://foxglove.dev/docs/studio/messages/introduction). +This package provides [Flatbuffer](https://google.github.io/flatbuffers/) classes for [Foxglove Schemas](https://docs.foxglove.dev/docs/visualization/message-schemas/introduction). ## Installation diff --git a/python/foxglove-schemas-protobuf/README.md b/python/foxglove-schemas-protobuf/README.md index badd20a1..7d354034 100644 --- a/python/foxglove-schemas-protobuf/README.md +++ b/python/foxglove-schemas-protobuf/README.md @@ -1,6 +1,6 @@ # Foxglove Schemas (Protobuf) -This package provides [Protobuf](https://developers.google.com/protocol-buffers/) classes for [Foxglove Schemas](https://foxglove.dev/docs/studio/messages/introduction). +This package provides [Protobuf](https://developers.google.com/protocol-buffers/) classes for [Foxglove Schemas](https://docs.foxglove.dev/docs/visualization/message-schemas/introduction). ## Installation diff --git a/ros_foxglove_msgs/package.xml b/ros_foxglove_msgs/package.xml index 9f282883..3657435d 100644 --- a/ros_foxglove_msgs/package.xml +++ b/ros_foxglove_msgs/package.xml @@ -4,7 +4,7 @@ foxglove_msgs 3.0.0 - foxglove_msgs provides visualization messages that are supported by Foxglove Studio. + foxglove_msgs provides visualization messages that are supported by Foxglove. Foxglove MIT diff --git a/ros_foxglove_msgs/ros1/CompressedVideo.msg b/ros_foxglove_msgs/ros1/CompressedVideo.msg index a67621c8..e8d8ec48 100644 --- a/ros_foxglove_msgs/ros1/CompressedVideo.msg +++ b/ros_foxglove_msgs/ros1/CompressedVideo.msg @@ -13,7 +13,7 @@ string frame_id # Compressed video frame data. # -# For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead. +# For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead. uint8[] data # Video format. diff --git a/ros_foxglove_msgs/ros2/CompressedVideo.msg b/ros_foxglove_msgs/ros2/CompressedVideo.msg index 4ddeec58..bbb48e0b 100644 --- a/ros_foxglove_msgs/ros2/CompressedVideo.msg +++ b/ros_foxglove_msgs/ros2/CompressedVideo.msg @@ -13,7 +13,7 @@ string frame_id # Compressed video frame data. # -# For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead. +# For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead. uint8[] data # Video format. diff --git a/schemas/README.md b/schemas/README.md index d03ca1fa..b397d807 100644 --- a/schemas/README.md +++ b/schemas/README.md @@ -1,6 +1,6 @@ # Foxglove schemas -See [Foxglove Schemas documentation](https://foxglove.dev/docs/studio/messages). +See [Foxglove Schemas documentation](https://docs.foxglove.dev/docs/visualization/message-schemas/introduction). All schemas are generated from [schemas.ts](/internal/schemas.ts). @@ -664,7 +664,7 @@ bytes Compressed video frame data. -For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead. +For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead. diff --git a/schemas/flatbuffer/CompressedVideo.fbs b/schemas/flatbuffer/CompressedVideo.fbs index 7c73d914..8d1a67fc 100644 --- a/schemas/flatbuffer/CompressedVideo.fbs +++ b/schemas/flatbuffer/CompressedVideo.fbs @@ -16,7 +16,7 @@ table CompressedVideo { /// Compressed video frame data. /// - /// For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead. + /// For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead. data:[uint8]; /// Video format. diff --git a/schemas/jsonschema/CompressedVideo.json b/schemas/jsonschema/CompressedVideo.json index b3a4b695..5443f9f8 100644 --- a/schemas/jsonschema/CompressedVideo.json +++ b/schemas/jsonschema/CompressedVideo.json @@ -27,7 +27,7 @@ "data": { "type": "string", "contentEncoding": "base64", - "description": "Compressed video frame data.\n\nFor packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead." + "description": "Compressed video frame data.\n\nFor packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead." }, "format": { "type": "string", diff --git a/schemas/jsonschema/index.ts b/schemas/jsonschema/index.ts index d995011b..be3af9a9 100644 --- a/schemas/jsonschema/index.ts +++ b/schemas/jsonschema/index.ts @@ -360,7 +360,7 @@ export const CompressedVideo = { "data": { "type": "string", "contentEncoding": "base64", - "description": "Compressed video frame data.\n\nFor packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead." + "description": "Compressed video frame data.\n\nFor packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead." }, "format": { "type": "string", diff --git a/schemas/omgidl/foxglove/CompressedVideo.idl b/schemas/omgidl/foxglove/CompressedVideo.idl index a5c75db3..08536926 100644 --- a/schemas/omgidl/foxglove/CompressedVideo.idl +++ b/schemas/omgidl/foxglove/CompressedVideo.idl @@ -16,7 +16,7 @@ struct CompressedVideo { // Compressed video frame data. // - // For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead. + // For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead. sequence data; // Video format. diff --git a/schemas/proto/foxglove/CompressedVideo.proto b/schemas/proto/foxglove/CompressedVideo.proto index 401b60c2..37e5ca50 100644 --- a/schemas/proto/foxglove/CompressedVideo.proto +++ b/schemas/proto/foxglove/CompressedVideo.proto @@ -18,7 +18,7 @@ message CompressedVideo { // Compressed video frame data. // - // For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead. + // For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead. bytes data = 3; // Video format. diff --git a/schemas/ros1/CompressedVideo.msg b/schemas/ros1/CompressedVideo.msg index a67621c8..e8d8ec48 100644 --- a/schemas/ros1/CompressedVideo.msg +++ b/schemas/ros1/CompressedVideo.msg @@ -13,7 +13,7 @@ string frame_id # Compressed video frame data. # -# For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead. +# For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead. uint8[] data # Video format. diff --git a/schemas/ros2/CompressedVideo.msg b/schemas/ros2/CompressedVideo.msg index 4ddeec58..bbb48e0b 100644 --- a/schemas/ros2/CompressedVideo.msg +++ b/schemas/ros2/CompressedVideo.msg @@ -13,7 +13,7 @@ string frame_id # Compressed video frame data. # -# For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead. +# For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead. uint8[] data # Video format. diff --git a/schemas/typescript/CompressedVideo.ts b/schemas/typescript/CompressedVideo.ts index 9b7771de..132a45f0 100644 --- a/schemas/typescript/CompressedVideo.ts +++ b/schemas/typescript/CompressedVideo.ts @@ -18,7 +18,7 @@ export type CompressedVideo = { /** * Compressed video frame data. * - * For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead. + * For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead. */ data: Uint8Array;