High-Level API#

HL-API uses the classes defined in LL-API and lets you quickly develop scripts or program in an object-oriented fashion with explicit definition of commands of different tester, module, port types. In addition, the HL-API layer provides functionalities such as:

Auto connection keep-alive
Auto index management
Resources identification tracking for push notification

Important

To continuously improve the usability of XOA Python API, the HL-API will be restructured, especially for the Layer-1 configuration APIs, in the next major release.

For backward-compatibility, the current HL-API is marked as V1. The restructured will be called V2.

You don’t need to do change to your import path or code if you continue to use HL-API V1. Both versions will keep being maintained and supported.

The restructuring won’t affect the LL-API.

The HL-API (V1) are categorized into:

Summary
Tester
Module
Port
Stream
Exception
Enum