Skip to content

Commit

Permalink
Change recommended voltage regulator to pololu and fix typos on wirin…
Browse files Browse the repository at this point in the history
…g page (#338)
  • Loading branch information
DeltaDizzy committed Feb 26, 2024
1 parent d49e31a commit 230cf04
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 12 deletions.
File renamed without changes
File renamed without changes
File renamed without changes
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
8 changes: 4 additions & 4 deletions source/docs/installation/updating.rst
Expand Up @@ -3,7 +3,7 @@ Updating PhotonVision

PhotonVision provides many different files on a single release page. Each release contains JAR files for performing "offline updates" of a device with PhotonVision already installed, as well as full image files to "flash" to supported coprocessors.

.. image:: release-page.png
.. image:: images/release-page.png
:alt: Example GitHub release page

In the example release above, we see:
Expand Down Expand Up @@ -37,13 +37,13 @@ Pre-release/development version of PhotonVision can be tested by installing/down

Github Actions builds pre-release version of PhotonVision automatically on PRs and on each commit merged to master. To test a particular commit to master, navigate to the `PhotonVision commit list <https://github.com/PhotonVision/photonvision/commits/master/>`_ and click on the check mark (below). Scroll to "Build / Build fat JAR - PLATFORM", click details, and then summary. From here, JAR and image files can be downloaded to be flashed or uploaded using "Offline Update".

.. image:: gh_actions_1.png
.. image:: images/gh_actions_1.png
:alt: Github Actions Badge

.. image:: gh_actions_2.png
.. image:: images/gh_actions_2.png
:alt: Github Actions artifact list

Built JAR files (but not image files) can also be downloaded from PRs before they are merged. Navigate to the PR in GitHub, and select Checks at the top. Click on "Build" to display the same artifact list as above.

.. image:: gh_actions_3.png
.. image:: images/gh_actions_3.png
:alt: Github Actions artifacts from PR
20 changes: 12 additions & 8 deletions source/docs/installation/wiring.rst
Expand Up @@ -15,24 +15,28 @@ On-Robot Wiring

.. note:: We recommend users use the `SnakeEyes Pi Hat <https://www.playingwithfusion.com/productview.php?pdid=133>`_ as it provides passive power over ethernet (POE) and other useful features to simplify wiring and make your life easier.

Recommended: Coprocessor with Passive POE (Gloworm, Pi with SnakeEyes)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Recommended: Coprocessor with Passive POE (Gloworm, Pi with SnakeEyes, Limelight)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1. Plug the `passive POE injector <https://www.revrobotics.com/rev-11-1210/>`_ into the coprocessor and wire it to PDP/PDB (NOT the VRM).
1. Plug the `passive POE injector <https://www.revrobotics.com/rev-11-1210/>`_ into the coprocessor and wire it to PDP/PDH (NOT the VRM).

2. Add a breaker to relevant slot in your PDP/PDB
2. Add a breaker to relevant slot in your PDP/PDH

3. Run an ethernet cable from the passive POE injector to your network switch / radio (we *STRONGLY* recommend the usage of a network switch, see the networking section for more info.)
3. Run an ethernet cable from the passive POE injector to your network switch / radio (we *STRONGLY* recommend the usage of a network switch, see the `networking <networking.rst>`_ section for more info.)

Coprocessor without Passive POE
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1a. Option 1: Get a micro USB (may be USB-C if using a newer Pi) to USB-A cable and plug the USB A side into a regulator like `this <https://www.amazon.com/KNACRO-Voltage-Regulator-Converter-Module/dp/B01HM12N2C/ref=sr_1_2>`_. Then, wire the regulator into your PDP/PDB and the Micro USB / USB C into your coprocessor.
1a. Option 1: Get a micro USB (may be USB-C if using a newer Pi) pigtail cable and connect the wire ends to a regulator like `this <https://www.pololu.com/product/4082>`_. Then, wire the regulator into your PDP/PDH and the Micro USB / USB C into your coprocessor.

1b. Option 2: Use a USB power bank to power your coprocessor. Refer to this year's robot rulebook on legal implementations of this.

1. Run an ethernet cable from your Pi to your network switch / radio (we *STRONGLY* recommend the usage of a network switch, see the networking section for more info.)
2. Run an ethernet cable from your Pi to your network switch / radio (we *STRONGLY* recommend the usage of a network switch, see the `networking <networking.rst>`_ section for more info.)

This diagram shows how to use the recommended regulator to power a coprocessor.

------------------------------------------------------------
.. image:: images/pololu-diagram.png
:alt: A flowchart-type diagram showing how to connect wires from the PDP or PDH to the recommended voltage regulator and then a Coprocessor.

.. note:: The regulator comes with optional screw terminals that may be used to connect the PDP/PDH and Coprocessor power wires if you do not wish to solder them.

Once you have wired your coprocessor, you are now ready to install PhotonVision.

0 comments on commit 230cf04

Please sign in to comment.