Emulator

From AsteroidOS
Revision as of 13:36, 17 June 2023 by Dodoradio (talk | contribs) (Add Emulator page from current wiki)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

If you don't have a supported smartwatch or if you want to develop an app without having to touch your device you can try AsteroidOS in an emulator.

Note: The emulator has some known issues under x11 sessions. Make sure that you run it in a wayland session. You can check your session type with echo $XDG_SESSION_TYPE.

Get a qemux86 build of AsteroidOS

Nightly builds of AsteroidOS for QEMU can be found here. You will need to download a prebuilt rootfs and kernel.

If you want more control over your asteroid image, you can also [[Building AsteroidOS | build AsteroidOS] yourself using the "qemux86" machine codename (the resulting rootfs and kernel will then be located in your build/tmp-glibc/deploy/images/qemux86/ directory).

Get an appropriate version of QEMU

The AsteroidOS emulator image requires a paravirtualized GPU only offered by QEMU when built with support for Virgil3D. Recent distribitions (such as Fedora 27 and later) offer QEMU packages built with Virgil and can be used directly to run AsteroidOS.

Unfortunately, most Linux distributions (such as Debian) still do not provide QEMU packages with support for this setup. Moreover, OpenEmbedded currently offers no clean way to build a host QEMU binary with Virgil due to various constraints. You then need to compile QEMU yourself.

Run AsteroidOS

Once you have a correct version of QEMU, a rootfs and a kernel, you can start AsteroidOS in an emulator using:

qemu-system-x86_64 -enable-kvm -kernel bzImage-qemux86.bin \
    -device virtio-vga-gl \
    -net nic -net user,hostfwd=tcp::2222-:22 \
    -drive format=raw,file="asteroid-image-qemux86.ext4" \
    -m 512 \
    -display sdl,gl=on \
    -cpu qemu64,+ssse3,+sse4.1,+sse4.2 \
    -device usb-mouse -machine usb=on \
    --append "verbose root=/dev/sda rw mem=512M video=800x800"

The previous command sets up a port forwarding so that you can connect to the emulator using SSH with the following command:

ssh -p 2222 ceres@localhost

Troubleshooting

Here are some common problems and their solutions.

  • Errors with -virtio-vga
    Newer versions of QEMU use -device virtio-vga-gl instead of -device virtio-vga,virgl=on, so if you get an error message complaining about virtio-vga-gl, you have an earlier version of QEMU. You can either use -device virtio-vga,virgl=on instead or upgrade to a newer version of QEMU.
  • Video corruption using NVIDIA drivers
    There have been reported problems on machines using proprietary NVIDIA drivers. One symptom is a black screen instead of the AsteroidOS screen which may or may not also show messages like these:
gl_version 46 - core profile enabled
GLSL feature level 460
failed to complete framebuffer 0x8cd7 asteroid-launch
  • Other symptoms include video artifacts (smearing, double screens) and crashing, usually with a message Segmentation fault (core dumped). If you're experiencing these and are using a proprietary NVIDIA driver, using gtk instead of sdl may work better. An example command line:
qemu-system-i386 -enable-kvm -kernel bzImage-qemux86.bin \
  -device virtio-vga-gl \
  -net nic -net user,hostfwd=tcp::2222-:22 \
  -drive file=asteroid-image-qemux86.ext4,format=raw \
  -m 512 \
  -display gtk,gl=on \
  -cpu qemu64,+ssse3,+sse4.1,+sse4.2 \
  -usb -device usb-tablet -device usb-mouse \
  --append "verbose root=/dev/sda rw mem=512M video=800x800"
  • Watch seems to lock up after a few seconds
    It's possible that the display is no longer updating but that the watch is actually still running. To make sure that the emulator continues to update the screen you can enter [[Useful Commands#Screen | demo mode] to keep the screen on. If you have followed this guide and the watch is listening on port 2222, this command will turn on demo mode.
ssh -t -p2222 root@localhost mcetool -D on