About the Evoke API

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

The API has two parts:

...

...

...

...

For information on running entirely via the API, without the Graphical User Interface (GUI), see Headless operation.

...

• 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:

...

Install the Evoke Python module

To install the Evoke Python module:

...

Install the Python module by running the batch file

To do this:

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

1. Navigate to the Scripts folder for the Python that you want to use:
   
   
   • For Python 3, the default installation folder is:
     C:\Users\<username>\AppData\Local\Programs\Python\Python<version>\Scripts
     
     
   • For Python 2.7, the default installation folder is:
     C:\Python27\Scripts
     
     
2. Open a command window or powershell in that folder.

3. Run the following command to install the Vicon Core API:

   Scroll only
   C:\Users\<username>\AppData\Local\Programs\Python\Python311\Scripts> .\pip.exe install "C:\Program Files\Vicon\Evoke 1.6\SDK\Python\vicon_core_api"

   
   

   Scroll ignore
   text

   
   

4. Run the following command to install the Evoke API:

   Scroll only
   C:\Users\<username>\AppData\Local\Programs\Python\Python311\Scripts> .\pip.exe install "C:\Program Files\Vicon\Evoke 1.6\SDK\Python\evoke_api"

   
   

   Scroll ignore
   text

   
   

Check that the Python module installed correctly

Check that the following modules have been installed:

...

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:

...