Call the API with JSON messages

All API calls are made with JSON messages containing a name and arguments.

Messages follow this form.

{"name":"message_name","args":["arg1","arg2",…]}

Message calls

The message calls for AVEVA XR Engage are as follows.

Navigate

{"name":"navigate","args":["TAG1234"]}

The navigate message is commanding AVEVA XR Engage to pick an element and zoom to it. If AVEVA XR Engage can find the requested tag, it will zoom to the element, highlight it, and show a tag tile for it.

Pick

{"name":"pick","args":["TAG1234"]}

The pick message is commanding AVEVA XR Engage to pick an element, but will not zoom to it. If AVEVA XR Engage can find the requested tag, it will highlight it and show a tag tile for it.

Xray mode

{"name":"xray","args":["true"]}

The xray message allows for turning xray mode on or off. It has one parameter that can be false (xray mode off) or true (xray mode on).

Set color

{"name":"setcolor","args":["Red","TAG49392","TAG2345","TAG3456"]}

The setcolor message allows for changing the color of elements associated with tags.

• The first array element is the color identification parameter. This parameter can be either an html hex color, such as #FA34A2 or a color name as in C# Color structure colors.

• The list of color names can be found at the following link:

  https://msdn.microsoft.com/en-us/library/system.drawing.color(v=vs.110).aspx

• Color names are case sensitive.

Reset colors

{"name":"resetcolors","args":[]}

The resetcolors message resets colors back to their default value.