Skip to content
This repository has been archived by the owner on Jul 16, 2024. It is now read-only.

[WIP] Update simulation example pages #302

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

amquake
Copy link
Member

@amquake amquake commented Jan 2, 2024

Updates simulation example walkthrough pages for new simulation functionality. Currently only includes Java.

  • simaimandrange
    • Background + video
    • Walkthrough
  • swervedriveposeestsim
    • Background + video
    • Walkthrough


The Java and C++ examples can be found inside the `photonlib-java-examples <https://github.com/PhotonVision/photonvision/tree/master/photonlib-java-examples>`_ and `photonlib-cpp-examples <https://github.com/PhotonVision/photonvision/tree/master/photonlib-cpp-examples>`_ subdirectories of the photonvision repository, respectively.

To run them, use the commands listed below. Photonlib must first be published to your local maven repository, then the ``copyPhotonlib`` task will copy the generated vendordep json file into each example. After that, the ``simulateJava`` (Java) or ``simulateNative`` (C++) task can be used like a normal robot project. Robot simulation with attached debugger is technically possible by using ``simulateExternalJava`` and modifying the launch script it exports, though unsupported.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would specify you should be running subprojectname:simulateJava -- otherwise it'll just spin up all the examples in random order

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants