diff --git a/source/docs/apriltag-pipelines/multitag.rst b/source/docs/apriltag-pipelines/multitag.rst index 134ba19..0d64a52 100644 --- a/source/docs/apriltag-pipelines/multitag.rst +++ b/source/docs/apriltag-pipelines/multitag.rst @@ -1,7 +1,7 @@ MultiTag Localization ===================== -PhotonVision can combine AprilTag detections from multiple simultaniously observed AprilTags from a particular camera wih information about where tags are expected to be located on the field to produce a better estimate of where the camera (and therefore robot) is located on the field. PhotonVision can calculate this multi-target result on your coprocessor, reducing CPU usage on your RoboRio. This result is sent over NetworkTables along with other detected targets as part of the ``PhotonPipelineResult`` provided by PhotonLib. +PhotonVision can combine AprilTag detections from multiple simultaniously observed AprilTags from a particular camera with information about where tags are expected to be located on the field to produce a better estimate of where the camera (and therefore robot) is located on the field. PhotonVision can calculate this multi-target result on your coprocessor, reducing CPU usage on your RoboRio. This result is sent over NetworkTables along with other detected targets as part of the ``PhotonPipelineResult`` provided by PhotonLib. .. warning:: MultiTag requires an accurate field layout JSON be uploaded! Differences between this layout and tag's physical location will drive error in the estimated pose output. diff --git a/source/docs/contributing/photonvision-docs/building-docs.rst b/source/docs/contributing/photonvision-docs/building-docs.rst index 7fe1b7f..93f63d6 100644 --- a/source/docs/contributing/photonvision-docs/building-docs.rst +++ b/source/docs/contributing/photonvision-docs/building-docs.rst @@ -12,7 +12,7 @@ Installing Python Dependencies ------------------------------ You must install a set of Python dependencies in order to build the documentation. To do so, you can run the following command in the root project directory: -``pip install -r requirements.txt`` +``python -m pip install -r requirements.txt`` Building the Documentation -------------------------- diff --git a/source/docs/programming/photonlib/getting-target-data.rst b/source/docs/programming/photonlib/getting-target-data.rst index 5beb977..1e9ddc6 100644 --- a/source/docs/programming/photonlib/getting-target-data.rst +++ b/source/docs/programming/photonlib/getting-target-data.rst @@ -24,8 +24,8 @@ The ``PhotonCamera`` class has two constructors: one that takes a ``NetworkTable .. code-block:: python - # Change this to match the name of your camera - self.camera = PhotonCamera("photonvision") + # Change this to match the name of your camera as shown in the web ui + self.camera = PhotonCamera("your_camera_name_here") .. warning:: Teams must have unique names for all of their cameras regardless of which coprocessor they are attached to. diff --git a/source/index.rst b/source/index.rst index e322c0a..62a87b4 100644 --- a/source/index.rst +++ b/source/index.rst @@ -1,7 +1,7 @@ .. image:: assets/PhotonVision-Header-onWhite.png :alt: PhotonVision -Welcome to the official documentation of PhotonVision! PhotonVision is the free, fast, and easy-to-use vision processing solution for the *FIRST*\ Robotics Competition. PhotonVision is designed to get vision working on your robot *quickly*, without the significant cost of other similar solutions. PhotonVision supports a variety of COTS hardware, including the Raspberry Pi 3 and 4, the `Gloworm smart camera `_, and the `SnakeEyes Pi hat `_. +Welcome to the official documentation of PhotonVision! PhotonVision is the free, fast, and easy-to-use vision processing solution for the *FIRST*\ Robotics Competition. PhotonVision is designed to get vision working on your robot *quickly*, without the significant cost of other similar solutions. PhotonVision supports a variety of COTS hardware, including the Raspberry Pi 3 and 4, the `Gloworm smart camera `_, the `SnakeEyes Pi hat `_, and the Orange Pi 5. Content ------- @@ -32,7 +32,7 @@ Content :link: docs/examples/index :link-type: doc - View various step by step guides on how to use data from PhotonVision in your code, along with a game-specific example. + View various step by step guides on how to use data from PhotonVision in your code, along with game-specific examples. .. grid:: 2 @@ -40,7 +40,7 @@ Content :link: docs/hardware/index :link-type: doc - Select appropriate hardware for high-quality, easy vision target detection. + Select appropriate hardware for high-quality and easy vision target detection. .. grid-item-card:: Contributing :link: docs/contributing/index