diff --git a/docs/source/docs/driver-mode/images/crosshair-switch.png b/docs/source/docs/driver-mode/images/crosshair-switch.png new file mode 100644 index 000000000..c86bc0e0f Binary files /dev/null and b/docs/source/docs/driver-mode/images/crosshair-switch.png differ diff --git a/docs/source/docs/driver-mode/images/driver-mode-camera-settings.png b/docs/source/docs/driver-mode/images/driver-mode-camera-settings.png new file mode 100644 index 000000000..d8fb509f6 Binary files /dev/null and b/docs/source/docs/driver-mode/images/driver-mode-camera-settings.png differ diff --git a/docs/source/docs/driver-mode/images/driver-mode-dashboard.png b/docs/source/docs/driver-mode/images/driver-mode-dashboard.png new file mode 100644 index 000000000..b6c0fe841 Binary files /dev/null and b/docs/source/docs/driver-mode/images/driver-mode-dashboard.png differ diff --git a/docs/source/docs/driver-mode/index.md b/docs/source/docs/driver-mode/index.md new file mode 100644 index 000000000..5d9a0c4c5 --- /dev/null +++ b/docs/source/docs/driver-mode/index.md @@ -0,0 +1,27 @@ +# Driver Mode + +Driver Mode is a type of pipeline that doesn't run any vision processing, intended for viewing from a human. + +## Enabling Driver Mode + +To enable Driver Mode, toggle the switch at the top of the Dashboard page for a selected camera. + +```{image} images/driver-mode-dashboard.png +:align: center +:alt: Driver Mode Toggle in the Dashboard Page +``` + +Alternatively, visit the camera settings page and toggle the "Driver Mode" switch for a selected camera. + +```{image} images/driver-mode-camera-settings.png +:align: center +:alt: Driver Mode Toggle in the Camera Settings Page +``` + +## Hiding the Crosshair +When Driver Mode is enabled, a green crosshair will be shown at the center of the camera stream. If you do not want to show the green crosshair at the center of the camera stream, toggle the "Crosshair" switch under the Input tab, as shown in the image below. + +```{image} images/crosshair-switch.png +:align: center +:alt: Crosshair Switch +``` diff --git a/docs/source/docs/pipelines/about-pipelines.md b/docs/source/docs/pipelines/about-pipelines.md index d4a37516d..fbb4d3ca1 100644 --- a/docs/source/docs/pipelines/about-pipelines.md +++ b/docs/source/docs/pipelines/about-pipelines.md @@ -26,6 +26,10 @@ This pipeline type is based on detecting objects using a neural network. The obj This pipeline type is only supported on the Orange Pi 5/5+ coprocessors due to its Neural Processing Unit used by PhotonVision to support running ML-based object detection. ::: +### Driver Mode + +Driver Mode is a type of pipeline that doesn't run any vision processing, intended for human viewing. For more information about Driver Mode, see the {ref}`Driver Mode documentation`. + ### Colored Shape This pipeline type is based on detecting different shapes like circles, triangles, quadrilaterals, or a polygon. An example usage would be detecting yellow PowerCells from the 2020 FRC game. You can read more about the specific settings available in the contours page. diff --git a/docs/source/index.md b/docs/source/index.md index 891782548..a8bbdc6de 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -102,6 +102,7 @@ docs/pipelines/index docs/apriltag-pipelines/index docs/reflectiveAndShape/index docs/objectDetection/index +docs/driver-mode/index docs/calibration/calibration ```