doytsujin / autd3-library-software

autd3 client library for C/C++

autd3

Version: 0.5.0

• This repository is forked from old version

• Here is API document

• For more details, refer to Wiki

Versioning

The meanings of version number x.y.z are

• x: Architecture version.
• y: Firmware version.
• z: Software version.

If the number of x or y changes, the firmware of FPGA or CPU must be upgraded.

This versioning was introduced after version 0.3.0.

⚠ CAUTION

• Before using, be sure to write the latest firmwares in dist/firmware. For more information, please see readme.

• If you are using Windows, you should disable Hyper-V, otherwise, it will cause unexpected behavior.

Requirements

• If you are using Windows, install Npcap with WinPcap API-compatible mode (recommended) or WinPcap.

Build

• Pre-built binaries and header files are on the GitHub Release page. Instead, if you want to build from source, install CMake version 3.12 or higher and follow the instructions below.
  • Windows:

    git clone https://github.com/shinolab/autd3-library-software.git --recursive 
    

    Then, run client/build.ps1 (Visual Studio 2019 is required)
  • Linux/Mac:

    git clone https://github.com/shinolab/autd3-library-software.git --recursive
    cd autd3-library-software/client
    mkdir build && cd build
    cmake ..
    make
    

Example

See client/examples

If you are using Linux/macOS, you may need to run as root.

For other programming languages

• Rust
• C#
• python
• julia

Citing

If you use this SDK in your research please consider to include the following citation in your publications:

S. Inoue, Y. Makino and H. Shinoda "Scalable Architecture for Airborne Ultrasound Tactile Display", Asia Haptics 2016

Author

Shun Suzuki, 2019-2020