Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update links and studio references #143

Merged
merged 3 commits into from
Mar 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,11 @@ jobs:
run: |
sudo pip install pydocstyle==6.1.1

- name: Downgrade pytest as a workaround for https://github.com/scientific-python/pytest-doctestplus/issues/240
if: ${{ matrix.ros_distribution == 'humble' || matrix.ros_distribution == 'iron' || matrix.ros_distribution == 'rolling' }}
run: |
sudo pip install pytest==8.0.2

- name: build and test ros2
if: ${{ matrix.ros_version == 2 }}
uses: ros-tooling/action-ros-ci@master
Expand Down
8 changes: 2 additions & 6 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// -*- jsonc -*-
{
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
"source.fixAll.eslint": "explicit"
},
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true,
Expand All @@ -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"
}
}
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 |
| --------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand All @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
2 changes: 1 addition & 1 deletion internal/generateMarkdown.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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).`,

Expand Down
4 changes: 2 additions & 2 deletions internal/generateRos.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion internal/generateTypeScript.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
};
Expand Down
2 changes: 1 addition & 1 deletion internal/schemas.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion python/foxglove-schemas-flatbuffer/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion python/foxglove-schemas-protobuf/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion ros_foxglove_msgs/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<name>foxglove_msgs</name>
<version>3.0.0</version>
<description>
foxglove_msgs provides visualization messages that are supported by Foxglove Studio.
foxglove_msgs provides visualization messages that are supported by Foxglove.
</description>
<maintainer email="[email protected]">Foxglove</maintainer>
<license>MIT</license>
Expand Down
2 changes: 1 addition & 1 deletion ros_foxglove_msgs/ros1/CompressedVideo.msg

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ros_foxglove_msgs/ros2/CompressedVideo.msg

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions schemas/README.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion schemas/flatbuffer/CompressedVideo.fbs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion schemas/jsonschema/CompressedVideo.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion schemas/jsonschema/index.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion schemas/omgidl/foxglove/CompressedVideo.idl

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion schemas/proto/foxglove/CompressedVideo.proto

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion schemas/ros1/CompressedVideo.msg

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion schemas/ros2/CompressedVideo.msg

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion schemas/typescript/CompressedVideo.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading