Skip to content

Commit

Permalink
Document protobufs and structs
Browse files Browse the repository at this point in the history
Resolves #2812

Signed-off-by: Jade Turner <spacey-sooty@proton.me>
  • Loading branch information
spacey-sooty committed Oct 21, 2024
1 parent 55de795 commit 89cb3b9
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions source/docs/software/telemetry/telemetry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ WPILib supports several :ref:`dashboards <docs/software/dashboards/index:Dashboa
* ``string[]``
* ``byte[]``

Telemetry data can be sent to a WPILib dashboard using an associated WPILib method (for more details, see the documentation for the individual dashboard in question), or by :ref:`directly publishing to NetworkTables <docs/software/networktables/networktables-intro:what is networktables>`.
Along with these primitive data types NetworkTables supports logging with two different serialisation formats, struct and protobuf. For most users structs will be preferable as they are significantly more performant, but in some cases (ie dynamically sized types) protobufs must be used. These can be used to log more complex data types such as `Pose2d`.

Check failure on line 25 in source/docs/software/telemetry/telemetry.rst

View workflow job for this annotation

GitHub Actions / check-spelling

[misspell] reported by reviewdog 🐶 "serialisation" is a misspelling of "serialization" Raw Output: ./source/docs/software/telemetry/telemetry.rst:25:88: "serialisation" is a misspelling of "serialization"

While NetworkTables does not yet support serialization of complex data types (this is tentatively scheduled for 2024), *mutable* types from user code can be easily extended to interface directly with WPILib dashboards via the ``Sendable`` interface, whose usage is described in the next article.
Telemetry data can be sent to a WPILib dashboard using an associated WPILib method (for more details, see the documentation for the individual dashboard in question), or by :ref:`directly publishing to NetworkTables <docs/software/networktables/networktables-intro:what is networktables>`.

0 comments on commit 89cb3b9

Please sign in to comment.