d22abdfd76
## Description Adds documentation for driver mode because it currently isn't documented. Closes #1824 ## Meta Merge checklist: - [x] Pull Request title is [short, imperative summary](https://cbea.ms/git-commit/) of proposed changes - [x] The description documents the _what_ and _why_ - [x] If this PR changes behavior or adds a feature, user documentation is updated - [x] If this PR touches photon-serde, all messages have been regenerated and hashes have not changed unexpectedly - [x] If this PR touches configuration, this is backwards compatible with settings back to v2024.3.1 - [x] If this PR touches pipeline settings or anything related to data exchange, the frontend typing is updated - [x] If this PR addresses a bug, a regression test for it is added --------- Co-authored-by: Gold856 <117957790+Gold856@users.noreply.github.com> Co-authored-by: Sam Freund <techguy763@gmail.com>
3.8 KiB
: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, 4, and 5, the SnakeEyes Pi hat, and the Orange Pi 5.
Content
.. grid:: 2
.. grid-item-card:: Quick Start
:link: docs/quick-start/index
:link-type: doc
Quick start to using Photonvision.
.. grid-item-card:: Advanced Installation
:link: docs/advanced-installation/index
:link-type: doc
Get started with installing PhotonVision on non-supported hardware.
.. grid:: 2
.. grid-item-card:: Programming Reference and PhotonLib
:link: docs/programming/index
:link-type: doc
Learn more about PhotonLib, our vendor dependency which makes it easier for teams to retrieve vision data, make various calculations, and more.
.. grid-item-card:: Integration
:link: docs/integration/index
:link-type: doc
Pick how to use vision processing results to control a physical robot.
.. grid:: 2
.. grid-item-card:: Code Examples
: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 game-specific examples.
.. grid-item-card:: Hardware
:link: docs/hardware/index
:link-type: doc
Select appropriate hardware for high-quality and easy vision target detection.
.. grid:: 2
.. grid-item-card:: Contributing
:link: docs/contributing/index
:link-type: doc
Interested in helping with PhotonVision? Learn more about how to contribute to our main code base, documentation, and more.
Source Code
The source code for all PhotonVision projects is available through our GitHub organization.
Contact Us
To report a bug or submit a feature request in PhotonVision, please submit an issue on the PhotonVision GitHub or contact the developers on Discord.
If you find a problem in this documentation, please submit an issue on the PhotonVision Documentation GitHub.
License
PhotonVision is licensed under the GNU GPL v3.
:caption: Getting Started
:hidden: true
:maxdepth: 0
docs/description
docs/quick-start/index
docs/hardware/index
docs/advanced-installation/index
:caption: Pipeline Tuning and Calibration
:hidden: true
:maxdepth: 0
docs/pipelines/index
docs/apriltag-pipelines/index
docs/reflectiveAndShape/index
docs/objectDetection/index
docs/driver-mode/index
docs/calibration/calibration
:caption: Programming Reference
:hidden: true
:maxdepth: 1
docs/programming/photonlib/index
docs/simulation/index
docs/integration/index
docs/examples/index
:caption: Additional Resources
:hidden: true
:maxdepth: 1
docs/troubleshooting/index
docs/additional-resources/best-practices
docs/additional-resources/config
docs/additional-resources/nt-api
docs/contributing/index
:caption: API Documentation
:hidden: true
:maxdepth: 1
Java <https://javadocs.photonvision.org>
C++ <https://cppdocs.photonvision.org/>