Overview
The Intel® ESQ package comes with the Command Line Interface (CLI) tool. It provides customers with the capability to run an Intel-provided test suite at the target system, with the goal of enabling customers to test their platform for a specific Intel® Edge Software package.
Refer to the Intel® Edge Software Recommended Hardware Program Overview for more details.
The following Intel ESQ Test Packages are supported by Intel ESQ version 11.1.0 (current). For information on specific Intel ESQ Test Packages or to Configure & Download Intel ESQ Test Packages, follow the links below:
- Intel ESQ for Metro AI Suite (formerly Intel ESQ AI Box for Video Analytics)
- Intel ESQ for Intel® Tiber™ Edge Platform
- Intel ESQ for Robotics SDK (formerly Intel ESQ for Autonomous Mobile Robots)
- Intel ESQ for Intel® Edge Controls for Industrial
Time to Complete: Approximately 45 mins for installation and 30 mins of execution depending on the test modules
Programming Language: Python* 3.10 package
Test Modules: Depends on the Test Modules
How It Works
This four-step qualification process is designed to be straightforward and user friendly. It allows system manufacturers and integrators to efficiently validate their systems and ensure they are ready for deployment in the market. The qualification not only provides assurance of the system's quality and reliability but also enhances its credibility among users and within the broader ecosystem.
Step 1: Download and Install the Qualification Tool
The first step requires registering and downloading the qualification tool. Once downloaded, the user must install the qualification tool on the system intended for certification.
Step 2: Run the Qualification Tool
Once the qualification tool is installed, the next step is to run the program. This involves initiating a series of automated tests that assess various aspects of the system's hardware and software.
Step 3: Submit the Report
Upon completion of the tests, the qualification tool generates a report detailing the system's performance and compatibility results. This report is then submitted to Intel for review. The submission process may be done through edge.software.device.qualification@intel.com. Should the user face issues during tool runtime or is not able to meet the set key performance indicators (KPIs), consult the Verified Reference Blueprint (VRB) documents or contact your Intel sales representative for support.
Step 4: Publish
Once approved, the newly qualified system is published in the Systems Recommended Hardware Portal.
Get Started
Intel ESQ CLI tool and test modules are installed as part of the Edge Software package.
NOTE:
Be aware that screenshots may show a package version number that is different from the current release. See the Release Notes for information on the current release.
Prerequisite
System bring-up is required before Intel ESQ software evaluation. To install base platform software, such as the operating system and drivers, see the dev-kit repository page or the system manufacturer’s software guidelines.
Download and Install Intel ESQ
Select Configure & Download on the following pages to download the package:
- Intel ESQ for Metro AI Suite (formerly Intel ESQ AI Box for Video Analytics)
- Intel ESQ for Robotics SDK (formerly Intel ESQ for Autonomous Mobile Robots)
NOTE:
The latest Intel ESQ version is 11.1.0.
- After downloading the Intel ESQ package, perform the following on the target system:
- Create an installation directory.
- Copy the package into the installation directory.
- Extract the package.
- Go to the edge_software_device_qualification directory, and change the permission of edgesoftware.
- Run the command to install the Intel ESQ and test modules on the target system.
- During installation, enter the product key you received when downloading the package. When the installation is complete, you see the message Installation of package complete and the installation status for each module.
NOTE: Ensure all the modules are installed successfully before using Intel ESQ. If any modules fail to install, run the command: ./edgesoftware update <Failed Module ID(s)> - Once the installation is completed, reboot the target system.
- The Intel ESQ CLI and the test modules are available in the target system.
Run the Application
NOTE:
Download and install Intel ESQ with the respective test modules before you continue in this section.
Perform the following procedure to run Intel ESQ as a complete test suite via the esdq CLI.
1. Change the directory to the location of Intel ESQ.
2. Check the Intel ESQ version.
Ensure the release version matches the version you downloaded. Here's an example of the output.
3. Run the following command to see the available command line options.
Here's an example of the output.
4. Run the following command to list the available test modules.
Here's an example of the output:
NOTE: The system test module is a pre-distributed test module in the Intel ESQ.
5. Run the Intel ESQ test execution. This command runs the test modules, which are listed in the package.
NOTE: Please provide the sudo password when prompted.
6. Once the test execution of the test modules is completed, a report is generated in the location stated in the command line. Go to the reports directory.
Here's an example of the directory contents.
7. View the report in your web browser. Email the HTML and ZIP files to edge.software.device.qualification@intel.com to continue the qualification process.
Here's an example of a report:
Release Notes
Current Version: 11.1.0
New in this Release
- Selective test module running
- Report template update for an optional test case
- Report timestamping
- Filter container support
- Text search in a report
- Optimize subprocess threading during runtime
- Bug fixes:
- Fix a subprocess verbosity in a Windows* execution.
- Fix a Python environment running issue.
- Test modules support
- Edge node software
Version: 11.0.0
New in this Release
- Intel ESQ architecture upgrade for base framework, base packaging.
- New architecture for module interface upgrade to support modularity verbose execution.
- Customer extension upgrade.
- Report generation with HTML interface.
- Log file handler and exception.
- Extraction of data sample into ZIP compression.
- Ubuntu* 22.04 LTS support.
Version: 10.0
New in this Release
- Intel ESQ README.txt is updated to capture the version information of the Python modules being used.
- Intel ESQ CLI report captures installed modules version information under Module Info table.
- Intel ESQ CLI is enhanced to support the individual test module execution by using the test module name. In earlier versions, ESDQ CLI used to support only through UUID.
Version: 9.0
New in this Release
- Intel ESQ README.txt is updated to capture the version information of the Python modules being used.
- Intel ESQ CLI report now supports up to 4 tables per test module.
- Intel ESQ CLI is enhanced to support parameters for both standalone and UUID based execution.
- Intel ESQ CLI is enhanced to support hyperlinks for logs navigation as part of test reporting.
Version: 8.0
New in this Release
- Intel ESQ README.txt is updated to capture the version information of the Python modules being used.
- Intel ESQ CLI report summary section is updated to capture recipe name, recipe version.
- Intel ESQ CLI report summary section is updated to show the test categories (Test Module) in tabular form.
- Intel ESQ CLI is enhanced to support the display of up to two images per test module as part of its reporting.
- Intel ESQ CLI version is made consistent across all test modules by removing minor versions.
Version: 7.0
New in this Release
- Incorporated customer feedback from previous release.
- Intel ESQ README.txt is updated to capture the version information of the Python modules being used.
- Intel ESQ CLI report shows Intel ESQ CLI Version
Version: 6.0
New in this Release
Incorporated customer feedback from previous 5.0 release.
- IIntel ESQ README.txt is updated to capture the version information of the Python modules being used.
- Intel ESQ CLI now supports parameters that can be passed to Test Modules.
- Intel ESQ CLI now supports up to two reports per Test Module.
Version: 5.0
New in this Release
Incorporated customer feedback from previous 4.0 release.
- Incorporated customer feedback from previous 4.0 release.
- Intel ESQ README.txt is updated to capture the version information of the Python modules being used.
- Intel ESQ CLI shows more details for version info.
- Intel ESQ CLI collects all the ESH installation logs as part of esdq final artifact zip file.
Version: 4.0
New in this Release
- Incorporated customer feedback from previous 3.0 release.
- Intel ESQ README.txt is updated to capture the version information of the Python modules being used.
- Intel ESQ CLI supports Debian 10 in addition to Ubuntu 20.04 & 18.04.
- IIntel ESQ Report now captures Module info to show the installation status.
- Intel ESQ CLI adds options to execute only interested Test Modules.
- Intel ESQ CLI reports now support the color code for each test case.
- Intel ESQ CLI shows more details for version info.
Version: 3.0
New in this Release
- Incorporated customer feedback from previous 2.0 release.
- Intel ESQ 3.0 integrates Intel® VATS and Edge Insights for Vision Test Module with OpenVINO™ toolkit 2021.3 support.
- Intel ESQ README.txt is updated to capture the version information of the Python modules being used.
- Intel ESQ CLI supports Ubuntu 20.04 and 18.04.
- Intel ESQ CLI System Info command displays GPU information.
- Intel ESQ CLI adds a new list command to list the supported test modules.
- Intel ESQ CLI shows more details for version info.
Known Issues
- Upgrade from EDTDT 2.0 to Intel ESQ 3.0 is not supported and a fresh install of Intel ESQ 3.0 is required.
Version: 2.0
New in this Release
- Incorporated feedback from customer from previous 1.0 release.
- Intel ESQ README.txt is updated to capture the version information of the Python modules being used.
- CLI supports Ubuntu 20.04 in addition to Ubuntu 18.04.
Known Issues
- Report generation in PDF has been deprecated in version 2.0 due to known issues.
Version: 1.0
New in this Release
- Initial Features for Recommended Configuration.
- Installs all the prerequisites and dependencies for the Edge Device Test and Diagnostic Tool.
- Supports below use cases:
- Run – launches the Vision test module and Intel® VATS test module. If there are no Vision accelerator cards present in the system, the HDDL test cases will fail.
- System info – collects the system information where the test is run.
- genreport – Generates a summary test report in html and pdf for all the test modules that were executed.
Known Issues
The pdf type of report is not showing the color format for Status.
Support
If you are unable to resolve your issues, contact the Support Forum.