====== Zedboard OLED Demo ======
{{:learn:programmable-logic:tutorials:zedboard-oled-demo:zed-oled-demo.jpg?400|}}
===== Overview =====
==== Description ====
The OLED Demo project demonstrates a simple usage of the Zedboard's
Organic Light Emitting Diode (OLED) Display.
==== Features Used ====
| ^ Not Used ^ Used ^
^ 8 User Switches | X | |
^ 9 User LEDs | | X |
^ 7 User Push Buttons | | X |
^ 512 MB DDR3 RAM | X | |
^ 256 Mb QSPI Flash | X | |
^ Five Digilent Pmod™ headers | X | |
^ FMC Header | X | |
^ USB-UART bridge | X | |
^ HDMI Output | X | |
^ VGA (12-bit Color) | X | |
^ FMC Header | X | |
^ 128×32 OLED Display | | X |
^ Audio Codec | X | |
^ SD Card Port | X | |
-------
===== Prerequisites =====
===Hardware===
* **Zedboard FPGA board**
* **Micro-USB cable**
* **Zedboard Power Supply**
===Software===
* **Vivado Design Suite 2023.1**
-----
===== 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/2023.1-1 | {{https://github.com/Digilent/Zedboard/releases/download/OLED/2023.1-1/Zedboard-OLED-hw.xpr.zip}} | See //Download and Launch the Zedboard OLED Demo//, below |
| Zedboard | OLED/2022.1-2 | {{https://github.com/Digilent/Zedboard/releases/download/OLED/2022.1-2/Zedboard-OLED-hw.xpr.zip}} | See //Download and Launch the Zedboard OLED Demo//, below |
| Zedboard | OLED/2022.1-1 | {{https://github.com/Digilent/Zedboard/releases/download/OLED/2022.1-1/Zedboard-OLED-hw.xpr.zip}} | See //Download and Launch the Zedboard OLED Demo//, below |
| Zedboard | OLED/2020.1-1 | {{https://github.com/Digilent/Zedboard/releases/download/OLED/2020.1-1/Zedboard-OLED-hw.xpr.zip}} | See //Download and Launch the Zedboard OLED Demo//, below |
| Zedboard | 2020.1 | [[https://github.com/Digilent/Zedboard-OLED/releases/download/untagged-7f718cd774e7d6fb3041/Zedboard-OLED-2020.1-1.zip|Release ZIP downloads]] | [[https://github.com/Digilent/Zedboard-OLED| v2020.1 Github README]] |
| Zedboard | 2018.2 | [[https://github.com/Digilent/Zedboard-OLED/releases/download/v2018.2-1/Zedboard-OLED-2018.2-1.zip|Release ZIP downloads]] | [[https://github.com/Digilent/Zedboard-OLED/tree/v2018.2-1| v2018.2-1 Github README]] |
| Zedboard | 2016.4 | [[https://github.com/Digilent/Zedboard-OLED/releases/download/v2016.4-1/Zedboard-OLED-2016.4-1.zip|Release ZIP downloads]] | [[https://github.com/Digilent/Zedboard-OLED/tree/v2016.4-1| v2016.4 Github README]] |
**Note for Advanced Users:** //GitHub sources for this demo can be found in the [[https://github.com/digilent/zedboard/tree/OLED/master|OLED/master]] branch of the Zedboard repository. 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.
<--
-------
===== Using the Zedboard OLED Demo ====
==== 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 BTNR Button to turn the display off. After turning off the display, wait for at least 3.5 seconds before turning off the board, reprogramming it or turning the display back on. This interval is necessary for the OLED supplies and control signals to correctly ramp down. 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 BTNR Button again.
>
>
=== Important ===
Make sure to turn off the OLED display by pressing the BTNR Button and waiting for at least 3.5 seconds 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|}}
{{tag>learn programmable-logic project zedboard}}