...

Evoke includes an extensive Application Programming Interface (API) for remote control, system monitoring and third-party application integration.

The API has two parts: , described in the following sections.

...

• Check Python version
• Installing Python
• Installing the Evoke Python module
• Check that the Python module installed correctly

  Scroll pagebreak

Check Python version

If you are not sure if you have Python installed or which version of Python you are using, you can open a command prompt and run the py command. For example:

...

If you do not have Python installed, see Install Python.

Install Python

To install Python 2 or 3:

1. Go to https://www.python.org/downloads/

2. Locate the required version and install Python, ensuring that Add python.exe to PATH is selected:

   

   In the above image, ABC is replaced with your username for the installation folder.

   Scroll pagebreak

Install the Evoke Python module

...

1. Locate the installation files. If you installed Evoke in the default location, they are found in this folder:

   C:\Program Files\Vicon\Evoke1.#\SDK\Python

   These folders and files are displayed:

   • evoke_api

   • sample_scripts
   • vicon_core_api
   • install_evoke_api.bat
   • readme.txt
   • uninstall_evoke_api.bat
2. Install the Evoke Python module in either of the following ways, depending on your particular installation:

   • The simplest way is to run the batch file (install_evoke_api.bat) that is included in the Evoke installation (as shown in the previous image). This usually works well if:

     • Python was installed to the PATH variable; or

     • Multiple versions of Python are installed, but you want to install the API to the latest version that you installed; or

     • Only a single version of Python is installed.

     If any of these conditions apply, see Install the python module by running the batch file.

   • In all other cases, install the Python module by using pip. This usually applies if:

     • Multiple versions of Python are installed, but you want to install to a specific version; or

     • Multiple different versions of Python are installed and you want to install to all of them (in this case, you must install the module for each version); or

     • Only a single version of Python is installed, but you didn't install to PATH.

     If any of these conditions apply, see Install the Python module by running pip.

Install the Python module by running the batch file

...

1. Navigate to the Python install folder:

   C:\Program Files\Vicon\Evoke1.#\SDK\Python
   
   

2. Double-click install_evoke_api.bat.

   The installation process initializes automatically.

Install the Python module by running pip

...

Check that the Python module installed correctly

...

For questions on using the Evoke API, contact Vicon Support.

Headless operation

Evoke may be operated entirely via API, in which case it may be advantageous to run without the Graphical User Interface (GUI). A separate executable is provided for this purpose:

...