Skip to content

Commit

Permalink
adds a few formatting tweaks and clarifications
Browse files Browse the repository at this point in the history
  • Loading branch information
sphawes committed Jul 8, 2024
1 parent 12a841f commit 876a107
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 21 deletions.
33 changes: 17 additions & 16 deletions docs/feeders/3-software-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,7 @@ LumenPnP feeders require a specific version of OpenPnP (the 2023-04-05 release),
!!! note "Machines Version v3.0.5+"
If your machine's version number is `v3.0.5` or greater, you already have firmware that supports feeders. You can skip this section.

1. Download the LumenPnP firmware with feeder support from the latest release [here](https://github.com/opulo-inc/lumenpnp/releases).

!!! danger "Important"
It is important that you pick the correct firmware file for your machine.

- If you have a v2, choose `v2-lumenpnp-firmware-feeder-support.bin`.
- If you have a v3, choose `v3-lumenpnp-firmware-feeder-support.bin`.
1. Download the LumenPnP firmware from the latest release [here](https://github.com/opulo-inc/lumenpnp/releases) that matches your machine's version. Firmware file names start with the machine versions they support.

2. Follow the instructions for [updating your LumenPnP's firmware](/guides/update-firmware/index.md).

Expand All @@ -40,33 +34,36 @@ LumenPnP feeders require a specific version of OpenPnP (the 2023-04-05 release),

!!! danger "Set Jumper to 3.3v"
Make sure that the jumper on your programmer is set to 3.3v. On the 3 pin header, make sure the jumper is connecting the center pin to the pin labeled "3.3v". The feeder logic operates at 3.3v, so it should be set to this prior to use.

![programmer jumper](img/programmer-jumper.jpg)

1. Connect the included programmer to your computer.
<!-- TODO: Get photo of programmer plugged into computer -->
2. Download a precompiled Feeder binary from the [Photon releases page](https://github.com/photonfirmware/photon/releases), or [compile it yourself](https://github.com/opulo-inc/feeder).
3. Download and install the [STM32CubeProgrammer application](https://www.st.com/en/development-tools/stm32cubeprog.html#section-get-software-table).
4. Open the STM32CubeProgrammer application
5. On the Blue dropdown next to the connect button, select `UART`
![Select UART](img/uart-dropdown.png)
5. On the Blue dropdown next to the connect button, select `UART`.

![Select UART](img/uart-dropdown.png)

6. Click the circular arrow icon to scan for new devices.
![stm32 cube software connect panel](img/refresh-button.png)

7. Click the `Port` drop down and select the new port that appears.
![stm32 cube software connect panel](img/refresh-button.png)

7. Click the `Port` drop down and select the new port that appears. On Mac, this port should start with `cu.usbmodem`.
![Select Port](img/select-port.png)

8. Set the following settings:
1. `Baudrate: 9600`
2. `Parity: Even`
3. `RTS: 0`
4. `DTR: 0`
5. `Read Unprotect (MCU): Unchecked`
6. `TZEN Regression (MCU): Unchecked`
3. `Read Unprotect (MCU): Unchecked`
4. `TZEN Regression (MCU): Unchecked`

![All Settings](img/all-settings.png)

9. Hold down the BOOT button located here on the feeder:
![boot button](img/boot-button.png)

![boot button](img/boot-button.png)

10. While holding the BOOT button, insert the pins of the programmer into the plated holes on the feeder as shown in the picture below. The holes are slightly offset, so the programmer pins will stay in contact with the through holes. Once connected, release the BOOT button. If the feeder's LED flashes and turns red, it is not ready to be programmed. Try again.

Expand All @@ -88,15 +85,19 @@ LumenPnP feeders require a specific version of OpenPnP (the 2023-04-05 release),
![Download Tab](img/download-tab.png)

1. Click the "Browse" button and navigate to the provided `firmware.bin` file.

![Browse Button](img/browse-button.png)

2. Ensure that the “Start address” is `0x08000000`.

![Start Address](img/start-address.png)

3. Click "Start Programming".

![Start Programming](img/start-programming.png)

4. Wait until the software prompts that the firmware has been downloaded successfully. You may disconnect the programmer from the feeder.

![programming complete pop up](img/programming-complete.png)

## Checking Current Firmware Version
Expand Down
4 changes: 2 additions & 2 deletions docs/feeders/5-openpnp-setup/feeder-openpnp-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Now you'll scan for and configure your LumenPnP Feeders in OpenPnP.

1. Click on the `Feeders` tab.

![Machine Setup Tab](img/feeders-tab.png)
![Machine Setup Tab](img/feeders-tab.png)

1. Click the plus to add a new feeder,
1. Click the plus to add a new feeder.

![Add a feeder](img/add-feeder.png)

Expand Down
6 changes: 3 additions & 3 deletions docs/openpnp/calibration/2-connect-to-machine/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Before connecting to the LumenPnP, you need to set which USB port to use for com
4. If you need to tweak your sensorless homing settings, make sure to adjust the values in the line starting with `M914` under `HOME_COMMAND`, *not* under `CONNECT_COMMAND`. -->

## Bottom Camera Config
## Bottom Camera Configuration

Next, you'll configure the cameras.

Expand Down Expand Up @@ -167,7 +167,7 @@ Next, you'll configure the cameras.
!!! danger "For Mac Users"
Due to an issue with the camera driver in OpenPnP, some Mac users might notice that the image settings are greyed out for you. There's a fantastic open-source application called [CameraController](https://github.com/Itaybre/CameraController) that can be used to edit these settings.

## Top Camera Config
## Top Camera Configuration

1. Under the `Machine Setup` tab, click on `Heads > ReferenceHead H1 > Cameras > OpenPnpCaptureCamera Top`.

Expand Down Expand Up @@ -195,4 +195,4 @@ Next, you'll configure the cameras.

## Next Steps

Next, we'll work on the camera's [the Homing Fiducials](../4-homing-fiducial/index.md).
Next, we'll set up the machine's [the homing fiducial](../4-homing-fiducial/index.md).

0 comments on commit 876a107

Please sign in to comment.