Getting Started: SIMYAN SDK

Instructions for getting started with our SDK

Some notes for now (should be updated later):

SDK Development Topics:

Please go to the following links and read the documentation. These are the core elements you'll need to understand in order to start writing code for the SIMYAN SDK. Please bring any questions you have with you when we meet on Friday.

• qicli

  • Link: http://doc.aldebaran.com/libqi/guide/qicli.html
  • This link is for the qicli command line tool on the NAO robot. To use it, you must first connect to the robot via SSH. It provides access to services information and the ability to call service methods from the command line.
  • SSH into robot: *Connect to same network as robot
    • In terminal run: ssh nao@
    • When prompted for a password, enter: nao

• qi.async method

  • Link: https://developer.softbankrobotics.com/nao6/naoqi-developer-guide/qi-framework/api-references/python-qi-api-reference/qiasync
  • The qi.async method is used to manage concurrent tasks. Pay close attention to the examples, and bring any questions you have on Friday.

• qi.bind function decorator

  • Link: https://developer.softbankrobotics.com/nao6/naoqi-developer-guide/qi-framework/api-references/python-qi-api-reference/bind-api
  • The qi.bind API is used to let the qi system know what types of parameters a service method expects and what type it returns.
  • You can also look at any of the template service classes currently in the feat/activities-master-module branch to see examples.

• Studio Tool Kit

  • Read the following markdown files to make sure you understand how to use the STK tools.
    • services: https://github.com/UCCS-Social-Robotics/studiotoolkit/blob/master/doc/stk_services.md
    • logging: https://github.com/UCCS-Social-Robotics/studiotoolkit/blob/master/doc/stk_logging.md
    • events: https://github.com/UCCS-Social-Robotics/studiotoolkit/blob/master/doc/stk_events.md