Skip to content

Document NetworkTables struct and protobuf serialization support#3109

Closed
jasondaming wants to merge 2 commits into
wpilibsuite:mainfrom
jasondaming:issue-2812-nt-struct-protobuf-docs
Closed

Document NetworkTables struct and protobuf serialization support#3109
jasondaming wants to merge 2 commits into
wpilibsuite:mainfrom
jasondaming:issue-2812-nt-struct-protobuf-docs

Conversation

@jasondaming

Copy link
Copy Markdown
Member

Summary

Updates NetworkTables and telemetry documentation to reflect that struct and protobuf serialization for complex data types is now supported (added in 2024).

Changes

  • Updated telemetry.rst to document struct/protobuf support for complex data types
  • Updated networktables-intro.rst to explain struct and protobuf encoding formats
  • Removed outdated statement saying struct/protobuf support was "not yet" available
  • Added examples of WPILib classes with built-in struct serialization (Pose2d, Rotation2d, SwerveModuleState, etc.)
  • Noted that teams can implement custom struct and protobuf serializers for their own data types

Fixes #2812

jasondaming and others added 2 commits October 6, 2025 22:15
Creates comprehensive FAQ document covering frequently asked questions and common issues in FRC, organized into categories:
- Build and deployment issues (connection, imaging, Gradle)
- Hardware issues (CAN bus, brownouts, pneumatics, motor controllers)
- Programming issues (null pointers, command-based, vendor libraries, crashes)
- Driver Station issues (communication, joysticks, dashboards)
- Firmware and software updates
- Network configuration (radio, competition, camera, sensors)

Each issue includes symptoms, solutions, and links to relevant documentation.

Fixes wpilibsuite#515
Update NetworkTables and telemetry documentation to reflect that struct and protobuf serialization for complex data types is now supported.

Changes:
- Update telemetry.rst to document struct/protobuf support for complex types
- Update networktables-intro.rst to explain struct and protobuf encoding
- Remove outdated statement saying struct/protobuf support was "not yet" available
- Add examples of WPILib classes with built-in struct serialization
- Mention that teams can implement custom serializers

Fixes wpilibsuite#2812

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

@sciencewhiz sciencewhiz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR should address @PeterJohnson comments from the last PR that attempted to document this: #2814 (comment)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't belong in this PR

Comment thread source/index.rst
docs/software/hardware-apis/index
docs/software/can-devices/index
docs/software/basic-programming/index
docs/software/support/common-issues-faq

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't belong in this PR

@sciencewhiz

Copy link
Copy Markdown
Collaborator

This PR should address @PeterJohnson comments from the last PR that attempted to document this: #2814 (comment)

Nevermind, I see that #3110 addresses that and seems to include this PRs content as well. Closing this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document NT protobuf/struct support

2 participants