Rabbit Virtual Compnents Platform

Table of Contents

• About
• Installing
• Usage
• Development
• Add New Component
• Issues
• Contributors

About

Rabbit is a virtual components platform for FDP3P7 FPGA board. It can receive and send data from/to the FPGA board via USB and show the data through the GUI.

Wonton is the previous version of Rabbit which is implemented in C#(core) and Electron(GUI). Rabbit is completely rewritten in C++ and Qt6 to improve the performance and stability.

Installing

1. Source Code compilation and Installation

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Before building Rabbit, you need to install Qt6 and xmake.

Clone the repository

git clone https://github.com/0xtaruhi/Rabbit.git
git submodule update --init --recursive

Build libusb

After cloning the repository, you need to build libusb first.

• Linux & MacOS

  cd libusb
  ./autogen.sh
  ./configure
  make

• Windows

  Open the libusb\msvc\libusb.sln with Visual Studio and build the static library. Then copy the libusb\msvc\libusb\Release\libusb-1.0.lib to libusb\libusb\.libs\usb-1.0.lib.

Build & Run Rabbit

Then you can build Rabbit.

cd ..
xmake build

Finally, you can run Rabbit.

xmake run

2. Binary Installation

Refer to the Release Page to download the binary package.

Usage

Refer to the User Manual for more information.

Development

Refer to the Developer Manual for more information.

Add New Component

Refer to the Add New Component Manual for more information.

Issues

If you have any questions or suggestions, please feel free to open an issue.

Here are some known issues:

1. libusb does not support MacOS M1 chip.

2. On ubuntu/debian, you need to install libxcb-cursor :

   sudo apt-get install libxcb-cursor0 
   

   when you run the binary package and get the error message:

   /usr/local/bin/Rabbit/rabbit_App: error while loading shared libraries: libQt6Widgets.so.6: cannot open shared object file: No such file or directory

Contributors

• 0xtaruhi - Main Developer
• Mxcln - Developer