KuriRobot / Kuri-Documentation

Documentation for Kuri the adorable home robot.
MIT License
17 stars 13 forks source link

madmux documentation doesn't reflect shipped version #25

Closed nickswalker closed 5 years ago

nickswalker commented 5 years ago

The header on our robot doesn't match the one in the docs. Ours includes an mdx_snap function.

I see that /opt/ros/indigo has madmux 0.2.0 and /opt/gizmo has madmux 0.3.0. It looks like the docs may be for 0.2.0. Is there any additional usage information that might come in handy for this newer version?

po1 commented 5 years ago

The one in the docs may have skipped that function because it is only useful for a type of video stream that was never enabled in the camera datapath configuration.

The Kuri doc has the most up to date and useful documentation.

po1 commented 5 years ago

@nickswalker feel free to open a PR if you feel like the header in the docs should be updated. I can see how it can lead to confusion when you see different versions of the same header, especially since there are different versions of the binary library installed on the robot, which is actually a bug (that will never be fixed 😞 )

po1 commented 5 years ago

In the mean time, I'm closing this.

nickswalker commented 5 years ago

👍 Informational, in case others find this: I've failed a couple times trying to set up a CMake project that links against one version of the library consistently (might build fine, but then I'll get runtime loader errors. Haven't managed to align the environment variables correctly I guess.) So I have fallen back to using the Python API based on the example: https://github.com/cse481wi19/cse481wi19/tree/39c00781bfce61ce7540b45a7dce82ecb7816491/kuri_camera