The Yanshee-sdk provides arm-linux based c and python library that allows developers to control YanShee robot
- Yanshee robot(Ex. Raspberry Pi 3 Main board)
- Monitor
- Output cable (Ex. HDMI-DVI/HDMI-VGA/HDMI-HDMI)
- USB cable/wireless(Recommond) mouse
- Stick sensors(Ex. infrared sensor)
- Ex. NOOBS developing system [Go to official website] (https://www.raspberrypi.org/downloads/noobs/)
- Prepare your workspace and download the SDK
We recommend running these commands from the home directory (~/) or Desktop; however, you can run the script anywhere.
sudo apt-get -y install doxygen swig
git clone https://github.com/UBTEDU/Yanshee-Raspi-SDK.git
- Compile the files
After compile the SDK, the doc, libs and python example are installed to "output" directory. This guide presumes that the SDK is in {YANSHEE_SDK}, which we will presume is your home directory. If you choose to use different folder names, please update the commands throughout this guide accoringly:
export YANSHEE_SDK=/home/pi/Yanshee-Raspi-SDK
cd $YANSHEE_SDK
make
- Set up dynamic library path
Please make sure your application can find these LIBs.
export LD_LIBRARY_PATH=$YANSHEE_SDK/output/libs/:$LD_LIBRARY_PATH
- Install python module and library
cd $YANSHEE_SDK/output/python/
sudo python setup.py install
PS:MAKE SURE RobotApi.py AND _RobotApi.so ARE IN THE FOLDER /usr/local/lib/python2.7/dist-packages
- Execute and learn the example
This is an example of how to control the robot to hit left. There are some other examples in "$YANSHEE_SDK/output/python/example", you can try them if you want.
cd $YANSHEE_SDK/output/python/example
python ubtStartRobotAction.py
- Build your own project
Befor you build your own project, you can find the SDK APIs in the below directory. After you enter the doc directory, please use your web browser to open "index.html". The documentation is generated by doxygen.
cd $YANSHEE_SDK/output/doc/