XA Kit Ethernet Control API Guide

This specification describes a command/response communication channel for integrators or end customers to use for the purpose of automating the operation of a Surface Analyst in a production or laboratory setting. It is expected that the Surface Analyst local touchscreen is still utilized for configuration settings, setting up surface profiles, and many maintenance functions.
NOTE: Important points to keep in mind when using the Control API and Data API:

• Using the Data API will have an impact on overall inspection rates possible.
  • When using the control API and Data API at the same time a sustained rate over 600 inspections per hour may not be possible.
• The Data API is not a real time communications channel – so standard TCP timeouts should take this into account with the expectation that any individual command/response may take up to 30 seconds or longer to complete for complex queries or when the system is under heavy load.
• Heavy use of the Data API can also impact the responsiveness of the Control API.

Ethernet Control API Guide