Home Page

Overview

This manual mainly introduces Machine Vision Camera SDK (MvCameraSDK), which provides multiple general APIs (compatiable with GigE Vision protocol, USB3 Vision protocol, Camera Link protocol, CoaXPress protocol, and XoFLink protocol, regardless of differences between device APIs), to implement the management of mutiple different frame grabbers and machine vision cameras.
The basic functions of MvCameraSDK consist of parameter configuration, image acquisition, image processing, and event function.

Contents

Release NotesIntroduces the main updates of each SDK version.
Development EnvironmentEnvironment configuration of the SDK, including network configuration and driver installation.
Programming GuideIntroduces how to connect cameras and acquire images.
API ReferenceIntroduces APIs and status codes.
Camera Parameter Node TableIncludes the commonly-used camera nodes. The parameters supported by the cameras are subject to those displayed in the MVS client.
Sample CodeIntroduces the common samples and the basic operation guide of the APIs.
FAQIntroduces debugging methods and frequently asked questions (FAQ).

Supported Operating System

Linux (32-bit/64-bit): Ubuntu 16.04 to 24.04 (32/64), Redhat7 (64), Centos7 (32/64), gcc/g++ version should be 4.8.5 or later.
Note
For frame grabbers, only 64-bit system is supported. It includes 64-bit Ubuntu 16.04 to 24.04, and gcc/g++ version 4.8.5 or later.

Client Development Directory

The client is installed in /opt/(software name)/ by default. You can customize the path as needed. The installation path contains the Development folder, which contains the dependent files of the SDK as follows:
  • Bin (compiled deliverable)
  • Documentations (secondary-developed documents, including the SDK developer guide, Demo user manual, etc.)
  • Includes (header file)
  • Libraries (DLL library)
  • Samples (sample codes for different programming languages)
Note
Files under development directories of different client version might vary. The actual circumstance shall prevail.
You can acquire driver and logserver (log service) in the folder.

Notes

  • The sample codes provided in this manual is only for reference. Improper sample code may fail to implement the expected function or even cause damage to the program. To ensure the normal operation of program, you should adjust the sample code according to your actual requirement and make a through test before using.