Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
programmable-logic:nexys-video:demos:oled [2022/09/12 13:54] – changed forum.digilentinc.com to forum.digilent.com Jeffreyprogrammable-logic:nexys-video:demos:oled [2023/08/25 00:04] (current) – Move to direct file links for downloads Arthur Brown
Line 1: Line 1:
 +====== Nexys Video OLED Demo ======
 +
 +{{:learn:programmable-logic:tutorials:nexys-video-oled-demo:oled-splash.jpg?nolink&400|}}
 +----
 +===== Description =====
 +
 +The OLED Demo project demonstrates a simple usage of the Nexys Video's 
 +Organic Light Emitting Diode (OLED) Display.
 +
 +^ Button     ^ Function                                                                                                                                                                           ^
 +| BTNC       | With the display on, each pixel on the display can\\ be lit up at once by pressing the center D-Pad button (BTNC).\\ Press the BTNC to return the display to its original state  |
 +| BTNU       | With the display on, you can load pre-defined text onto the\\ display by pressing the up D-Pad button (BTNU)                                                                      |
 +| CPU_RESET  | The OLED display can be turned on and off by pressing the\\ CPU_RESET button (located above the PROG button).                                                                      |
 +| BTND       | To clear the display, press the down D-Pad button (BTND)                                                                                                                           |
 +
 +----
 +===== Inventory =====
 +
 +  * Nexys Video 
 +  * A MicroUSB Cable
 +  * Vivado installation compatible with the latest release of this demo (2023.1)
 +    * //See [[programmable-logic:guides:installing-vivado-and-vitis|Installing Vivado, Vitis, and Digilent Board Files]] for installation instructions.//
 +  * Nexys Video 12 Volt Power Supply
 +
 +----
 +===== 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 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                                ^
 +| Nexys Video    | @#C0EEBD: OLED/2023.1-1  | {{https://github.com/Digilent/Nexys-Video/releases/download/OLED/2023.1-1/Nexys-Video-OLED-hw.xpr.zip}}  | See //Using the Latest Release//, below  |
 +| Nexys Video    | OLED/2022.1-2            | {{https://github.com/Digilent/Nexys-Video/releases/download/OLED/2022.1-2/Nexys-Video-OLED-hw.xpr.zip}}  | See //Using the Latest Release//, below  |
 +| Nexys Video    | OLED/2022.1-1            | {{https://github.com/Digilent/Nexys-Video/releases/download/OLED/2022.1-1/Nexys-Video-OLED-hw.xpr.zip}}  | See //Using the Latest Release//, below  |
 +| Nexys Video    | OLED/2021.1-1            | {{https://github.com/Digilent/Nexys-Video/releases/download/OLED/2021.1-1/Nexys-Video-OLED-hw.xpr.zip}}  | See //Using the Latest Release//, below  |
 +| Nexys Video    | OLED/2020.1-1            | {{https://github.com/Digilent/Nexys-Video/releases/download/OLED/2020.1-1/Nexys-Video-OLED-hw.xpr.zip}}  | See //Using the Latest Release//, below  |
 +| Nexys Video    | v2018.2-1                | [[https://github.com/Digilent/Nexys-Video-OLED/releases/tag/v2018.2-1|Release ZIP downloads]]   | [[https://github.com/Digilent/Nexys-Video-OLED/tree/v2018.2-1| v2018.2-1 Github README]]                |
 +| Nexys Video    | v2016.4-2                | [[https://github.com/Digilent/Nexys-Video-OLED/releases/tag/v2016.4-2|Release ZIP downloads]]   | [[learn/programmable-logic/tutorials/github-demos/start|Using Digilent Github Demo Projects (Legacy)]]  |
 +
 +**Note for Advanced Users:** //GitHub sources for this demo can be found in the [[https://github.com/digilent/nexys-video/tree/OLED/master|OLED/master]] branch of the Nexys-Video 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 #^
 +
 +<WRAP group>
 +
 +{{page>programmable-logic:guides:using-github-releases#hardware_only_release_before_programming&noheader}}
 +
 +--> Set up the Nexys Video #
 +
 +Plug the 12V Power Supply into the Nexys Video.
 +
 +Plug the MicroUSB into the PROG 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.
 +</WRAP>
 +
 +<--
 +----
 +=====Functionality=====
 +
 +This portion will help you run the demo and observe all its features.
 +
 +>1) Startup and Bringdown
 +>
 +>The procedures for safely turning on and off the OLED display are handled by the CPU Reset Button. When the board is first turned on, 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. 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 CPU Reset Button again.
 +>
 +>{{:learn:programmable-logic:tutorials:nexys-video-oled-demo:oled-rston.jpg?nolink&500|}}
 +>
 +>{{:learn:programmable-logic:tutorials:nexys-video-oled-demo:oled-rstoff.jpg?nolink&500|}}
 +
 +>2) Toggle the Display
 +>
 +>Once the display has been turned on, each LED on the display can be lit up at once by pressing the center D-Pad button. To return the display to its original state, press this button again.
 +>
 +>{{:learn:programmable-logic:tutorials:nexys-video-oled-demo:oled-btnc.jpg?nolink&500|}}
 +
 +>3) Update the Display
 +>
 +>With the display on, you can load text onto the display by pressing the up D-Pad button. To clear the display again, press the down D-Pad button. Toggling the entire display while text is loaded will still turn each LED on, then return the display to the splash screen text.
 +>
 +>{{:learn:programmable-logic:tutorials:nexys-video-oled-demo:oled-btnu.jpg?nolink&500|}}
 +>
 +>{{:learn:programmable-logic:tutorials:nexys-video-oled-demo:oled-btnd.jpg?nolink&500|}}
 +
 +
 +<WRAP round important 660px>
 +===Important===
 +Before turning off or reprogramming your board, shut down the OLED display by pressing the **CPU_RESET** button and wait for at least 3.5 seconds.
 +</WRAP>
 +
 +===== Additional Resources =====
 +
 +All materials related to the use of the Nexys Video can be found on its [[..:start|Resource Center]].
 +
 +For a walkthrough of the process of creating a simple HDL project in Vivado, see [[programmable-logic:guides:getting-started-with-vivado]]. Information on important parts of the GUI, 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.digilent.com/forum/4-fpga/|FPGA]] section of the Digilent Forum.