Surge API

This repository contains examples and wrappers using the API for the Surge Hand.

This API supports Python and C++ for Linux. This API was tested on Ubuntu 22.04 with Python 3.10.

Quickstart

1. Build the C++ package

   cd surge-hand-api/cpp/surge_wrapper
   mkdir build && cd build
   cmake ..
   make -j4
   

2. Find the corresponding USB Port of the hand(s). The following command may be useful:

   sudo dmesg | grep -i ftdi
   

   You should look for something along the lines of

   [  123.456900] ftdi_sio 1-2:1.0: FTDI USB Serial Device converter detected
   [  123.457012] usb 1-2: FTDI USB Serial Device converter now attached to ttyUSB0
   

   which helps to indicate which USB port your hand(s) are on. In this example, a singular hand has been detected and is attached to /dev/ttyUSB0. The default port is set to /dev/ttyUSB0, however, you can change the default by editting Line 18 on surge_wrapper.py or set the port accordingly when initializing the Surge Hand with the port parameter.

Troubleshooting

Access Denied to /dev/ttyUSB0

If you have issues with accessing /dev/ttyUSB0, try

sudo usermod -a -G dialout $USER
sudo reboot