6.5.1 Use JSON

JSON
JavaScript Object Notation is a standardised way of writing commands or small programs to and from devices.
REST API
REpresentational State Transfer Application programming interface is a protocol that allows other devices to be controlled by the Encore3 or control the Encore3 with other devices.
About JSON

The Encore3 allows for remote interaction with the software through API calls in the form of JSON requests. These requests can be sent by automated systems to control or gather info about the Encore3. It is possible to test these commands one by one to get a better understanding of what they do.

Note: These tests must actually be executed by the desired device to get a proper response. Be mindful of the state of the device and the command that is being tested.

API calls can be blocked by the security settings of the Encore3. For more information, see:

About command documentation

All Barco developed devices will communicate to Event Master Toolset using the REST API. For more information, see the reference guide on the Barco website:

For commands of devices that were not made by Barco, see the documentation of the manufacturer.

How to test

  1. Select a desired command from the desired category in the menu on the left.

    Image 6–39

    The command will be entered on the right of the menu.

  2. Is the IP address correct?

    • If no, clear the IP address by clicking the button Clear IP Address and enter the desired IP address. For more information on how to find the IP address, see “Unit ID, IP address” or “About”.
    • If yes, go to next step.
    Image 6–40

  3. Modify the generated command if required. (optional)

    Tip: The command window size can be changed by dragging the bottom right corner of the window.
    Image 6–41

  4. Click on Send Command to run the chosen command.

    Image 6–42

    The results of the command are printed in the corresponding field:

    • Error, details what went wrong with the command.
    • Response, shows what the command returns.
    • Success value, shows ‘0’ if the command was successful and no return value.

  5. Must other commands be tested?

    • If no, no further actions are required.
    • If yes, click on Clear Command and go to step 1.
    Image 6–43