Add doc about NT4 MessagePack serialization. #2042
Conversation
| to make a little dashboard app that can be run by the Driver Station. These | ||
| snippets are simplified, eliding several parts required to make them work. | ||
| To run it yourself, check out the complete demo found | ||
| `here. <https://github.com/truher/radar>`__ |
There was a problem hiding this comment.
Let's not link to a full demo, we typically don't do that in the docs.
There was a problem hiding this comment.
yeah, i felt uncomfortable with that too, but i wanted to be able to provide both the elided version and the version that actually works. one of my favorite things about wpilib is the "make example" button, it gives you something that works. is there another way to achieve that?
|
|
||
| public class Target { | ||
| public enum Type { | ||
| TAG, ALLY, OPPONENT, SELF |
There was a problem hiding this comment.
Might be more interesting to teams if this was AprilTag oriented?
There was a problem hiding this comment.
i'll try using the AprilTag class directly and update.
There was a problem hiding this comment.
ah, i remember why i didn't do that in the first place: (a) i didn't want to deal with pose3d since it's a 2d visualization and (b) i wanted to use the same representation for other kinds of targets, e.g. other robots, the "self" observer, etc. also i have this tickle in the back of my mind that says you should never use domain objects for IPC, i.e. better to decouple the models of apps that don't get updated or deployed as a unit.
| } | ||
| } | ||
|
|
||
| And there you have it! POJO's passed end to end courtesy of Network Tables 4, |
There was a problem hiding this comment.
We don't use the term POJO anywhere in the docs at present... maybe just say Java object?
| messages can be hard to interpret when things go wrong, for example, an error | ||
| about missing dependent libraries doesn't mention **which** dependent library | ||
| is missing. See `the project <https://github.com/truher/radar>`__ | ||
| for details in build.gradle and how to load native code in the application. |
There was a problem hiding this comment.
We already have a section on building desktop NT applications, so this section isn't needed (or should be merged there if relevant).
There was a problem hiding this comment.
yeah, i started by following those instructions, but they didn't work for me. i struggled with the build for a long time, actually, so i felt like i needed to say something about it; i didn't end up with a gradle file that looked very much like the existing doc. i'm not sure what the sources of trouble really were. inclusion of dependent native libs? usage of beta artifacts? the nonfunctional static initializer loaders? i'm definitely not an expert with any of the gradle stuff, but i'm sure almost none of the wpilib users are either, so i wanted to provide something that would work unmodified. i guess this is kinda the same issue as the first one above: i'd like to be able to provide something that will "just work".
|
Update on this? |
|
sorry, i've been distracted. i'm actually still a bit concerned about being able to supply something that actually works, without including a bunch of detail about gradle. anyway i'll make the changes i know how to make. |
As I mentioned in https://github.com/wpilibsuite/BetaTest/discussions/163 I wrote up an example
of NT4 + MessagePack for Java. This is my first doc contribution, I have no idea what I'm doing,
feedback welcome. @PeterJohnson