Emulator Installation

XCENA Emulator provides a virtual environment that allows you to run and test the SDK without physical XCENA hardware. It reproduces the behavior of the XCENA device and host system, enabling software development and debugging in a fully simulated setup.

XCENA Emulator is distributed as part of the XCENA Docker image.

Prerequisites

  • Docker Engine installed on the host system
  • KVM support available on the host (/dev/kvm)

1. Prepare Docker Environment

For Docker installation and XCENA Docker image setup, refer to Docker Installation.

Start the container with KVM support, SYS_ADMIN capability, and the current username passed through to the container.

# e.g., docker run -it --name xcena_sdk --device=/dev/kvm --cap-add=SYS_ADMIN -e USER=$USER xcenadev/sdk:1.4.0
docker run -it --name <container> --device=/dev/kvm --cap-add=SYS_ADMIN -e USER=$USER xcenadev/sdk:<tag>

2. Verify Installation

2.1 Launch QEMU

$ cd /work/emulator
$ ./run.sh

If XCENA emulator is successfully installed, this command launches a QEMU instance with the XCENA virtual device enabled.
For detailed usage instructions, refer to the Emulator Guide.

2.2 Verify SDK in QEMU

Navigate to the SDK directory and check the installation contents, following the same procedure as described in Verify Installation

$ cd ~/sdk
# Check SDK files

Next, confirm that the virtual XCENA device is detected correctly:

$ xcena_cli num-device
Number of devices : 1

You can now proceed with the Tutorials in QEMU.