====== Arty Z7 Out-of-Box Demo ======

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

{{reference/programmable-logic/arty-z7/arty-z7_-_top_-_600.png}}

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

The Arty Z7 Out-of-Box Demo is similar to the demo that comes preprogrammed on the board when shipped to customers. The demo uses a wide range of the board's peripherals including the HDMI video inputs and outputs, audio output, LEDs, buttons, and USB-UART bridge.

The demo forwards signals from the HDMI input port to the HDMI output port. To use this feature of the demo, an HDMI-capable source and an HDMI-capable monitor are required, as well as two HDMI cables.

When any button is pressed, an audio sample is generated by the Zynq processor and is streamed out over the audio output jack for approximately 4.5 seconds. The sample generated is a 261 Hz sine wave, also known as the musical note C4. Note that as the audio output is mono, only one ear of a pair of headphones would play the audio.

As long as the demo is running, the two RGB LEDs alternate cycling through the colors red, green, blue, and white.

The user LEDs are continuously set to the state of user buttons. When only one of the user switches is switched on, the LEDs are inverted.

Status messages are printed out over UART to a connected serial terminal.
----
===== Inventory =====

  * Arty Z7 with a MicroUSB Programming Cable (and external Power Supply)
  * 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.//
  * Headphones or Speaker with 3.5mm Audio Jack
  * HDMI-capable Source (likely the computer running Vitis and Vivado)
  * HDMI-capable Monitor
  * 2 HDMI Cables

----
===== 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.//

^ Board Variant  ^ Release Tag  ^ Release Downloads  ^ Setup Instructions  |
| Arty Z7-10  | @#C0EEBD: 10/OOB/2020.1-1  | [[https://github.com/Digilent/Arty-Z7/releases/tag/10/OOB/2020.1-1|Release ZIP Downloads]] | See //Using the Latest Release//, below  |
| Arty Z7-20  | @#C0EEBD: 10/OOB/2020.1-1  | [[https://github.com/Digilent/Arty-Z7/releases/tag/20/OOB/2020.1-1|Release ZIP Downloads]] | See //Using the Latest Release//, below  |
| Arty Z7-10  | v2018.2-1                | [[https://github.com/Digilent/Arty-Z7-10-OOB/releases/tag/v2018.2-1|Release ZIP Downloads]] | [[https://github.com/Digilent/Arty-Z7-10-OOB/tree/v2018.2-1|v2018.2-1 Github README]]  |
| Arty Z7-20  | v2018.2-1                | [[https://github.com/Digilent/Arty-Z7-20-OOB/releases/tag/v2018.2-1|Release ZIP Downloads]] | [[https://github.com/Digilent/Arty-Z7-20-OOB/tree/v2018.2-1|v2018.2-1 Github README]]  |

**Note for Advanced Users:** //All demos for the Arty Z7 are provided through the [[https://github.com/Digilent/Arty-Z7|Arty-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 Arty Z7 #

Plug the microUSB programming cable into the Arty Z7's PROG/UART port, the HDMI cables into the HDMI IN and HDMI OUT port (and into the source and sink, respectively), and the headphones or speaker into the AUDIO OUT port.

----
<--

{{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>
<--

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

All materials related to the use of the Arty 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.

----
<code>{{tag>project arty-z7}}</code>