====== Zybo Z7-20 Pcam 5C Demo ======

<WRAP todo important>
== Under Construction ==
</WRAP>

{{:learn:programmable-logic:tutorials:zybo-z7-pcam-5c-demo:pcam-5c-running.jpg?500}}

----
===== Description =====

The Zybo Z7 Pcam 5C project demonstrates the usage of the Pcam 5C as a video source by forwarding the streaming image data out to the HDMI TX port.
The behavior is as follows:

  * Video data streams in through the Pcam port and out through the HDMI source (TX) port.
  * A UART interface is available to configure the image sensor and additional post processing IP Cores. 

The following table lists the currently supported video resolutions and output formats from the image sensor. Note that resolutions with frame rates lower than 60Hz are over sampled to 60Hz to output over the HDMI port.


^ Supported Resolutions:        ^ Supported Image Sensor Output Formats  ^ Supported OV5640 Image Processing Features                                                                               ^ Image Processing Features Performed in FPGA  ^
| * 1080p@30Hz\\   * 720p@60Hz  | * RAW                                  | * Auto White Balance\\ * Defective Pixel Canceling\\ * Auto Exposure Control (AEC)\\ * Auto 50/60Hz Luminance Detection  | * Demosaicing \\ * Gamma Correction          |

----
===== Inventory =====

  * Zybo Z7 with a MicroUSB Programming Cable and External Power Supply
  * **1 Pcam 5C Assembly**
  * Vivado and Vitis installations compatible with the latest release of this demo (2020.1)
    * //See [[programmable-logic:guides:installing-vivado-and-vitis|Installing Vivado, Vitis, and Digilent Board Files]] for installation instructions.//
  * Serial Terminal application to receive messages printed by the demo
    * //See [[programmable-logic:guides:serial-terminals:start]] for more information.//
  * **1 HDMI Type A to Type A or HDMI Type A to DVI-D cable**
  * **HDMI or DVI monitor**

----
===== Download and Usage Instructions =====

First and foremost, releases - consisting of a set of files for download - are only compatible with a specific version of the Xilinx tools, as specified in the name of the release (referred to as a //release tag//). In addition, releases are only compatible with the specified variant of the board. For example, a release tagged "20/DMA/2020.1" for the Zybo Z7 is only to be used with the -20 variant of the board and Xilinx tools (Vivado and Vitis) version 2020.1.

The latest release version for this demo is highlighted in green.

**Note:** //Releases for FPGA demos from before 2020.1 used a different git structure, and used a different release tag naming scheme.//

**Releases not yet available for 2020.1.**

^ Board Variant  ^ Release Tag  ^ Release Downloads  ^ Setup Instructions  |
| Zybo Z7-20  | v2019.1-1  | [[https://github.com/Digilent/Zybo-Z7-20-pcam-5c/releases/tag/v2019.1-1|Release ZIP Downloads]] | [[https://github.com/Digilent/Zybo-Z7-20-pcam-5c/tree/v2019.1-1|v2019.1-1 README]]  |
| Zybo Z7-20  | v2018.2-2  | [[https://github.com/Digilent/Zybo-Z7-20-pcam-5c/releases/tag/v2018.2-2|Release ZIP Downloads]] | [[https://github.com/Digilent/Zybo-Z7-20-pcam-5c/tree/v2018.2-2|v2018.2-2 README]]  |
| Zybo Z7-20  | v2017.4  | [[https://github.com/Digilent/Zybo-Z7-20-pcam-5c/releases/tag/v2017.4|Release ZIP Downloads]] | [[learn/programmable-logic/tutorials/github-demos/start|Using Github Demo Projects (Legacy)]]  |
| Zybo Z7-20  | v2016.4-1  | [[https://github.com/Digilent/Zybo-Z7-20-pcam-5c/releases/tag/v2016.4-1|Release ZIP Downloads]] | [[learn/programmable-logic/tutorials/github-demos/start|Using Github Demo Projects (Legacy)]]  |

**Note for Advanced Users:** //All demos for the Zybo Z7 are provided through the [[https://github.com/Digilent/Zybo-Z7|Zybo-Z7]] repository on Github. Further documentation on the structure of this repository can be found on this wiki's [[programmable-logic:documents:git]] page.//
----
Instructions on the use of the latest release can be found in this dropdown:

--> Using the Latest Release #
<WRAP group>

{{page>programmable-logic:guides:using-github-releases#baremetal_release_before_programming&noheader}}

--> Set up the Zybo Z7 #
<WRAP group>
<WRAP group> <WRAP column half>
Plug one end of the HDMI cable into the HDMI TX port of the Zybo Z7 and the other into your HDMI monitor. Also attach a USB micro cable between the Zybo Z7 and your computer. Finally, attach an external 5V power supply, since the power demand surpasses the USB power budget. 
</WRAP> <WRAP column half>
{{:learn:programmable-logic:tutorials:zybo-z7-pcam-5c-demo:pcam-5c-hdmi.jpg?800|}}
</WRAP> </WRAP>

<WRAP group> <WRAP column half>
Attach the Pcam 5C assembly (which includes the Pcam 5C and the attached 15-pin flat flexible cable) by inserting the other end of the FFC into the Pcam connector on the Zybo Z7 as shown in image below. Ensure the cable is securely latched by pressing down firmly on the connector with two fingers. For a more detailed set of instructions, see the Pcam section in the [[programmable-logic:zybo-z7:reference-manual#pcam_port|Zybo Z7 Reference Manual]]. If the cable has become disconnected from the Pcam 5C, please see the [[add-ons:pcam-c:reference-manual|Pcam 5C reference manual]] for instructions on how to reattach it.
</WRAP> <WRAP column half>
{{:reference:programmable-logic:zybo-z7:zybo-z7-pcam-attach.png|}}
</WRAP> </WRAP>
</WRAP>
----
<--

{{page>programmable-logic:guides:using-github-releases#baremetal_release_programming&noheader}}

At this point, the demo is now running on your board. Refer to the [[#description|Description]] section of this document for more information on what it does.
----
Additional steps beyond here present how you can use the other archive provided in the release, containing the hardware project, to rebuild the Vivado project, and use a newly exported XSA file to update the platform in Vitis.
----
{{page>programmable-logic:guides:using-github-releases#baremetal_update_specification&noheader}}


</WRAP>
<--

----
==== Pcam 5C Image Sensor and Post Processing Options ====

  * **a**: Change Resolution
    * This option can be used to change the resolution of the video coming from the sensor. Currently 1080p@15Hz is not supported and will cause problems if used.
  * **b**: Change Liquid Lens Focus
    * This option is not compatible with this version of the Pcam 5C and should be ignored 
  * **d**: Change Image Format
    * This option was included for debugging purposes and should always be set to RAW mode (option 2)
  * **e**: Write a Register inside the Image Sensor
    * This option allows you to write a value to any register inside the Image sensor over the OmniVision SCCB interface. You will need to refer to the OV5640 datasheet for information on the register map. This option is very useful for exploring the features of the image sensor.
  * **f**: Read a Register inside the Image Sensor
    * This option allows you to read the value of any register inside the Image sensor over the OmniVision SCCB interface.
  * **g**: Change Gamma Correction Factor Value
    * This option allows you to change the amount of gamma correction that is done by the custom AXI stream IP inside the FPGA.
  * **h**: Change AWB Settings
    * This option allows you to adjust how the image sensor is doing auto white balancing. There are 3 modes: Advanced, simple, and disabled. The advanced mode sometimes causes dramatic shifts between "red-ish" and "blue-ish" tints. 

----
==== Pcam 5C Image Quality Notes ====

This demo uses our own software to configure the OV5640 image sensor and open source IP to post process the image data. Both of these facets of the software greatly affect image quality. This section documents the current quality of the images our software is able to produce with the Pcam 5C. We are aware that the quality of the image affects whether the Pcam 5C is suitable for some applications, so the information provided here can be used to help determine if the product will fit your needs.

We hope to improve the quality of the images produced by this demo over time, so please check back often if you are interested. We are also looking into using Xilinx IP and the Omnivision provided Linux drivers to provide another software option for the use of the Pcam 5C. This will be made available if successful on the [[add-ons:pcam-5c:start|Pcam 5C Resource Center]].

----
=== Color Accuracy ===

We have seen some issues with the accuracy of the colors produced in some conditions. The affect is that colors seem less vivid and washed out. In some cases the image tends to look a little skewed towards "yellow-ish". When the gamma adjustment is set higher, this affect becomes more noticeable. The images below compare the image produced with the Pcam 5C to images produced by a high-quality USB web camera. The camera used was a Logitech C920. The USB camera is on the right and the Pcam 5C image is on the left.

<WRAP group> <WRAP column half>
{{:learn:programmable-logic:tutorials:zybo-z7-pcam-5c-demo:pcam-5c-color-gamma-crop.jpg|}}
<html><center></html>//No gamma correction, Pcam on Left//<html></center></html>
</WRAP> <WRAP column half>
{{:learn:programmable-logic:tutorials:zybo-z7-pcam-5c-demo:pcam-5c-color-crop.jpg|}}
<html><center></html>//With gamma correction, Pcam on Left//<html></center></html>
</WRAP> </WRAP>

----
=== Over Exposure ===

Some situations that contain a mix of dark and bright areas will cause the brighter areas to look overexposed. Notice the very white area of the image produced by the Pcam 5C.

{{ :learn:programmable-logic:tutorials:zybo-z7-pcam-5c-demo:pcam-5c-exposure-crop.jpg?600 }}

<html><center></html>//Pcam on left with overexposure of bright area on right side of image//<html></center></html>

----
=== Visible Border Line ===

The top and left edges of the image have a single pixel gray line. This artifact is introduced by our post processing IP,  axis_raw_demosaic. It is an accepted side-effect of the border interpolation algorithm used and we plan to provide other options in future versions of the IP. The image below is taken with the Pcam 5C lens cap on, which makes the gray line very visible on the all black image. 

{{ :learn:programmable-logic:tutorials:zybo-z7-pcam-5c-demo:pcam-5c-border.jpg?600 }}

<html><center></html>//Gray border on the top and left sides//<html></center></html>

----
===== Additional Resources =====

All materials related to the use of the Zybo Z7 can be found on its [[..:start|Resource Center]].

For a walkthrough of the process of creating a simple baremetal software project in Vivado and Vitis, see [[programmable-logic:guides:getting-started-with-ipi]]. Information on important parts of the GUIs, and indirect discussion of the steps required to modify, rebuild, and run this demo in hardware can also be found here.

For technical support, please visit the [[https://forum.digilentinc.com/forum/4-fpga/|FPGA]] section of the Digilent Forum.

----