Skip to main content

Camera Information

Introduction

These functions are retrieving the information from the camera device.

VxGetUSBFirmwareVersion

Function:

int VxGetUSBFirmwareVersion(std::shared_ptr<VxCamera> vxcam, std::string& fwVer)

Function Description:

  • This function retrieves the firmware version of the connected USB camera.

Parameter Description:

  • vxcam : A pointer shared ownership of a camera obtained from VxInitialCameraDevice().
  • fwVer : A string to store the firmware version.
  • Return:
    • C++ : return 0 = PASS, return -1 = FAIL
    • Python : tuple(return_code, fwVer)

      return_code : return 0 = PASS, return -1 = FAIL

Example:

std::string fwVer;
// get the version of USB device firmware
VxGetUSBFirmwareVersion(vxcam, fwVer);

VxGetTEVSFirmwareVersion

Function:

int VxGetTEVSFirmwareVersion(std::shared_ptr<VxCamera> vxcam, std::string& fwVer)

Function Description:

  • This function retrieves the firmware version of the connected TEVS camera.

Parameter Description:

  • vxcam : A pointer shared ownership of a camera obtained from VxInitialCameraDevice().
  • fwVer : A string to store the firmware version.
  • Return:
    • C++ : return 0 = PASS, return -1 = FAIL
    • Python : tuple(return_code, fwVer)

      return_code : return 0 = PASS, return -1 = FAIL

Example:

std::string fwVer;
// get the version of TEVS device firmware
VxGetTEVSFirmwareVersion(vxcam, fwVer);

VxGetSensorUniqueID

Function:

int VxGetSensorUniqueID(std::shared_ptr<VxCamera> vxcam, std::string& uniqueId)

Function Description:

  • This function is used to retrieve the unique ID from the sensor.

Parameter Description:

  • vxcam : A pointer shared ownership of a camera obtained from VxInitialCameraDevice().
  • uniqueId : A string to store the sensor ID.
  • Return:
    • C++ : return 0 = PASS, return -1 = FAIL
    • Python : tuple(return_code, uniqueId)

      return_code : return 0 = PASS, return -1 = FAIL

Example:

std::string uniqueId;
// get the sensor id
VxGetSensorUniqueID(vxcam, uniqueId);

VxGetSensorFirmwareVersion

Function:

int VxGetSensorFirmwareVersion(std::shared_ptr<VxCamera> vxcam, std::string& fwVer)

Function Description:

  • This function is used to retrieve the firmware version from the sensor.

Parameter Description:

  • vxcam : A pointer shared ownership of a camera obtained from VxInitialCameraDevice().
  • fwVer : A string to store the firmware version.
  • Return:
    • C++ : return 0 = PASS, return -1 = FAIL
    • Python : tuple(return_code, fwVer)

      return_code : return 0 = PASS, return -1 = FAIL

Example:

std::string fwVer;
// get the firmware version
VxGetSensorFirmwareVersion(vxcam, fwVer);