Remote Image Build Guide

Unlike Classic PYNQ, there are no pre-built PYNQ.remote SD card images available, so you’ll need to build your own. This can be done in one of two ways:

1. Using the Docker-based build flow: This is the recommended method for most users, as it simplifies the build process and ensures a consistent environment.

2. Integrating the PYNQ metalayer into a custom Petalinux build: This is for advanced users who want to customize their Petalinux projects with PYNQ features

Prerequisites:

• Host machine with Ubuntu 2022.4 OS installed

• AMD Tools: Vivado, Vitis, and Petalinux version 2024.1

• Docker installation

Using the Docker-base build flow:

1. Clone the PYNQ repository:

   git clone --recursive https://github.com/Xilinx/PYNQ.git
   

2. Follow the Docker-based build instructions in the sdbuild/README.md file to set up the build environment.

3. Build the remote image for your target board:

   # Inside the Docker container
   cd PYNQ/sdbuild
   make pynqremote BOARDS=<board_name>
   

   Replace <board_name> with your target board (e.g., ZCU104, Pynq-Z2).

4. Flash the generated image from sdbuild/output/ to an SD card and boot your device (See Writing an SD Card Image for more details).

5. After booting, the pynq-remote server will start automatically, allowing you to connect to the device (see Quick Start for more details).

Alternative: Using PYNQ Metalayer in Custom Petalinux Build

Advanced users can integrate the meta-pynq metalayer into their own Petalinux projects. Refer to the Petalinux Tools Reference Guide (UG1144) for detailed instructions.