====== ZedBoard OLED Demo ======
== Under Construction ==
{{:learn:programmable-logic:tutorials:zedboard-oled-demo:zed-oled-demo.jpg?400|}}
----
===== Description =====
This project is a Vivado demo using the Zedboard's LEDs, pushbuttons and OLED Display written in Verilog. When programmed onto the board, the display will automatically be initialized. When you are done operating the demo, and want to turn your board off, press the CPU Reset Button to turn the display off. LED0 is tied to the status of the OLED display. If the LED0 is on so is the OLED display. The display can be turned on from an off state by pressing the CPU Reset Button again. The OLED Display is controlled by the BTNR, BTNU, BTNC and BTND of the D-Pad Buttons.
Additional information on how this demo can be used can be found in appropriate READMEs, linked below.
----
===== Inventory =====
* ZedBoard with a MicroUSB Programming Cable and an external 12V Power Supply
* Vivado installation 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.//
----
===== Download and Usage Instructions =====
The following releases of this demo can be used with instructions found in the corresponding READMEs in order to run the demo.
Releases are only compatible with the version of the Xilinx tools specified in the release version number. In addition, releases are only compatible with the specified variant of the board. For example, the v2020.1-1 release for ZedBoard can only be used with Vivado 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 ^
| ZedBoard | @#C0EEBD: OLED/2020.1-1 | [[reference:programmable-logic:zedboard:demos:start|Release ZIP Downloads]] | See //Using the Latest Release//, below | |
| ZedBoard | v2018.2-1 | [[https://github.com/Digilent/Zedboard-OLED/releases/tag/v2018.2-1|Release ZIP downloads]] | [[https://github.com/Digilent/Zedboard-OLED|Github README]] |
**Note for Advanced Users:** //All demos for the ZedBoard are provided through the [[https://github.com/Digilent/ZedBoard|ZedBoard]] 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 #
{{page>programmable-logic:guides:using-github-releases#hardware_only_release_before_programming&noheader}}
--> Set up the ZedBoard #
Plug the microUSB programming cable into the ZedBoard's JTAG port and the 12V Power Supply into the Barrel Jack next to the JTAG port.
----
<--
{{page>programmable-logic:guides:using-github-releases#hardware_only_release_programming&noheader}}
At this point, the demo is now running on your board. Refer to the [[#description|Description]] and [[#functionality|Functionality]] sections of this document for more information on what it does.
<--
===== Functionality =====
==== 1. Startup and Bringdown ====
>The OLED display can be turned on and off by pressing the right D-Pad Button (BTNR). When the board is first programmed, the display will automatically be initialized. When you are done operating the demo, and want to turn your board off, press the CPU Reset Button to turn the display off. The status of the display is indicated by LED0, if it is on, the display is on. The display can be turned on from an off state by pressing the CPU Reset Button again.
>
>
=== Important ===
Make sure to turn off the OLED display before shutting down or reprogramming your board.
>
>{{:learn:programmable-logic:tutorials:zedboard-oled-demo:zed-oled-on.jpg?500|}}
==== 2. Toggle the Display ====
>Once the display has been turned on, each pixel on the display can be lit up at once by pressing the center D-Pad button (BTNC). To return the display to its original state, press this button again.
>
>{{:learn:programmable-logic:tutorials:zedboard-oled-demo:zed-oled-full.jpg?500|}}
==== 3. Display Strings ====
>With the display on, you can load pre-defined text onto the display by pressing the up D-Pad button (BTNU). To clear the display, press the down D-Pad button (BTND).
>
>{{:learn:programmable-logic:tutorials:zedboard-oled-demo:zed-oled-splash.jpg?500|}}
----
===== Additional Resources =====
All materials related to the use of the ZedBoard 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.
----
{{tag>project zedboard}}