Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
Classes | Enumerations | Functions | Variables
rsimpl::ivcam Namespace Reference

Classes

struct  cam_auto_range_request
 
struct  cam_calibration
 
struct  camera_calib_params
 

Enumerations

enum  fw_cmd : uint8_t {
  fw_cmd::GetMEMSTemp = 0x0A, fw_cmd::DebugFormat = 0x0B, fw_cmd::TimeStampEnable = 0x0C, fw_cmd::GetFWLastError = 0x0E,
  fw_cmd::HWReset = 0x28, fw_cmd::GVD = 0x3B, fw_cmd::GetCalibrationTable = 0x3D, fw_cmd::CheckI2cConnect = 0x4A,
  fw_cmd::CheckRGBConnect = 0x4B, fw_cmd::CheckDPTConnect = 0x4C, fw_cmd::GetIRTemp = 0x52, fw_cmd::GoToDFU = 0x80,
  fw_cmd::OnSuspendResume = 0x91, fw_cmd::GetWakeReason = 0x93, fw_cmd::GetWakeConfidence = 0x92, fw_cmd::SetAutoRange = 0xA6,
  fw_cmd::SetDefaultControls = 0xA6, fw_cmd::GetDefaultControls = 0xA7, fw_cmd::AutoRangeSetParamsforDebug = 0xb3, fw_cmd::UpdateCalib = 0xBC,
  fw_cmd::BIST = 0xFF, fw_cmd::GetPowerGearState = 0xFF
}
 
enum  FirmwareError : int32_t {
  FirmwareError::FW_ACTIVE = 0, FirmwareError::FW_MSAFE_S1_ERR, FirmwareError::FW_I2C_SAFE_ERR, FirmwareError::FW_FLASH_SAFE_ERR,
  FirmwareError::FW_I2C_CFG_ERR, FirmwareError::FW_I2C_EV_ERR, FirmwareError::FW_HUMIDITY_ERR, FirmwareError::FW_MSAFE_S0_ERR,
  FirmwareError::FW_LD_ERR, FirmwareError::FW_PI_ERR, FirmwareError::FW_PJCLK_ERR, FirmwareError::FW_OAC_ERR,
  FirmwareError::FW_LIGURIA_TEMPERATURE_ERR, FirmwareError::FW_CONTINUE_SAFE_ERROR, FirmwareError::FW_FORZA_HUNG, FirmwareError::FW_FORZA_CONTINUES_HUNG,
  FirmwareError::FW_PJ_EYESAFETY_CHKRHARD, FirmwareError::FW_MIPI_PCAM_ERR, FirmwareError::FW_MIPI_TCAM_ERR, FirmwareError::FW_SYNC_DISABLED,
  FirmwareError::FW_MIPI_PCAM_SVR_ERR, FirmwareError::FW_MIPI_TCAM_SVR_ERR, FirmwareError::FW_MIPI_PCAM_FRAME_SIZE_ERR, FirmwareError::FW_MIPI_TCAM_FRAME_SIZE_ERR,
  FirmwareError::FW_MIPI_PCAM_FRAME_RESPONSE_ERR, FirmwareError::FW_MIPI_TCAM_FRAME_RESPONSE_ERR, FirmwareError::FW_USB_PCAM_THROTTLED_ERR, FirmwareError::FW_USB_TCAM_THROTTLED_ERR,
  FirmwareError::FW_USB_PCAM_QOS_WAR, FirmwareError::FW_USB_TCAM_QOS_WAR, FirmwareError::FW_USB_PCAM_OVERFLOW, FirmwareError::FW_USB_TCAM_OVERFLOW,
  FirmwareError::FW_Flash_OEM_SECTOR, FirmwareError::FW_Flash_CALIBRATION_RW, FirmwareError::FW_Flash_IR_CALIBRATION, FirmwareError::FW_Flash_RGB_CALIBRATION,
  FirmwareError::FW_Flash_THERMAL_LOOP_CONFIGURATION, FirmwareError::FW_Flash_REALTEK, FirmwareError::FW_RGB_ISP_BOOT_FAILED, FirmwareError::FW_PRIVACY_RGB_OFF,
  FirmwareError::FW_PRIVACY_DEPTH_OFF, FirmwareError::FW_COUNT_ERROR
}
 

Functions

void claim_ivcam_interface (uvc::device &device)
 
size_t prepare_usb_command (uint8_t *request, size_t &requestSize, uint32_t op, uint32_t p1=0, uint32_t p2=0, uint32_t p3=0, uint32_t p4=0, uint8_t *data=0, size_t dataLength=0)
 
void get_gvd (uvc::device &device, std::timed_mutex &mutex, size_t sz, char *gvd, int gvd_cmd=(int) fw_cmd::GVD)
 
void get_firmware_version_string (uvc::device &device, std::timed_mutex &mutex, std::string &version, int gvd_cmd=(int) fw_cmd::GVD, int offset=0)
 
void get_module_serial_string (uvc::device &device, std::timed_mutex &mutex, std::string &serial, int offset)
 
void force_hardware_reset (uvc::device &device, std::timed_mutex &mutex)
 
void enable_timestamp (uvc::device &device, std::timed_mutex &mutex, bool colorEnable, bool depthEnable)
 
void set_auto_range (uvc::device &device, std::timed_mutex &mutex, int enableMvR, int16_t minMvR, int16_t maxMvR, int16_t startMvR, int enableLaser, int16_t minLaser, int16_t maxLaser, int16_t startLaser, int16_t ARUpperTH, int16_t ARLowerTH)
 
void get_laser_power (const uvc::device &device, uint8_t &laser_power)
 
void set_laser_power (uvc::device &device, uint8_t laser_power)
 
void get_accuracy (const uvc::device &device, uint8_t &accuracy)
 
void set_accuracy (uvc::device &device, uint8_t accuracy)
 
void get_motion_range (const uvc::device &device, uint8_t &motion_range)
 
void set_motion_range (uvc::device &device, uint8_t motion_range)
 
void get_filter_option (const uvc::device &device, uint8_t &filter_option)
 
void set_filter_option (uvc::device &device, uint8_t filter_option)
 
void get_confidence_threshold (const uvc::device &device, uint8_t &conf_thresh)
 
void set_confidence_threshold (uvc::device &device, uint8_t conf_thresh)
 

Variables

const uvc::extension_unit depth_xu { 1, 6, 1, { 0xA55751A1, 0xF3C5, 0x4A5E, { 0x8D, 0x5A, 0x68, 0x54, 0xB8, 0xFA, 0x27, 0x16 } } }
 

Enumeration Type Documentation

◆ FirmwareError

enum rsimpl::ivcam::FirmwareError : int32_t
strong
Enumerator
FW_ACTIVE 
FW_MSAFE_S1_ERR 
FW_I2C_SAFE_ERR 
FW_FLASH_SAFE_ERR 
FW_I2C_CFG_ERR 
FW_I2C_EV_ERR 
FW_HUMIDITY_ERR 
FW_MSAFE_S0_ERR 
FW_LD_ERR 
FW_PI_ERR 
FW_PJCLK_ERR 
FW_OAC_ERR 
FW_LIGURIA_TEMPERATURE_ERR 
FW_CONTINUE_SAFE_ERROR 
FW_FORZA_HUNG 
FW_FORZA_CONTINUES_HUNG 
FW_PJ_EYESAFETY_CHKRHARD 
FW_MIPI_PCAM_ERR 
FW_MIPI_TCAM_ERR 
FW_SYNC_DISABLED 
FW_MIPI_PCAM_SVR_ERR 
FW_MIPI_TCAM_SVR_ERR 
FW_MIPI_PCAM_FRAME_SIZE_ERR 
FW_MIPI_TCAM_FRAME_SIZE_ERR 
FW_MIPI_PCAM_FRAME_RESPONSE_ERR 
FW_MIPI_TCAM_FRAME_RESPONSE_ERR 
FW_USB_PCAM_THROTTLED_ERR 
FW_USB_TCAM_THROTTLED_ERR 
FW_USB_PCAM_QOS_WAR 
FW_USB_TCAM_QOS_WAR 
FW_USB_PCAM_OVERFLOW 
FW_USB_TCAM_OVERFLOW 
FW_Flash_OEM_SECTOR 
FW_Flash_CALIBRATION_RW 
FW_Flash_IR_CALIBRATION 
FW_Flash_RGB_CALIBRATION 
FW_Flash_THERMAL_LOOP_CONFIGURATION 
FW_Flash_REALTEK 
FW_RGB_ISP_BOOT_FAILED 
FW_PRIVACY_RGB_OFF 
FW_PRIVACY_DEPTH_OFF 
FW_COUNT_ERROR 

◆ fw_cmd

enum rsimpl::ivcam::fw_cmd : uint8_t
strong
Enumerator
GetMEMSTemp 
DebugFormat 
TimeStampEnable 
GetFWLastError 
HWReset 
GVD 
GetCalibrationTable 
CheckI2cConnect 
CheckRGBConnect 
CheckDPTConnect 
GetIRTemp 
GoToDFU 
OnSuspendResume 
GetWakeReason 
GetWakeConfidence 
SetAutoRange 
SetDefaultControls 
GetDefaultControls 
AutoRangeSetParamsforDebug 
UpdateCalib 
BIST 
GetPowerGearState 

Function Documentation

◆ claim_ivcam_interface()

void rsimpl::ivcam::claim_ivcam_interface ( uvc::device &  device)

◆ enable_timestamp()

void rsimpl::ivcam::enable_timestamp ( uvc::device &  device,
std::timed_mutex &  mutex,
bool  colorEnable,
bool  depthEnable 
)

◆ force_hardware_reset()

void rsimpl::ivcam::force_hardware_reset ( uvc::device &  device,
std::timed_mutex &  mutex 
)

◆ get_accuracy()

void rsimpl::ivcam::get_accuracy ( const uvc::device &  device,
uint8_t &  accuracy 
)

◆ get_confidence_threshold()

void rsimpl::ivcam::get_confidence_threshold ( const uvc::device &  device,
uint8_t &  conf_thresh 
)

◆ get_filter_option()

void rsimpl::ivcam::get_filter_option ( const uvc::device &  device,
uint8_t &  filter_option 
)

◆ get_firmware_version_string()

void rsimpl::ivcam::get_firmware_version_string ( uvc::device &  device,
std::timed_mutex &  mutex,
std::string &  version,
int  gvd_cmd = (int) fw_cmd::GVD,
int  offset = 0 
)

◆ get_gvd()

void rsimpl::ivcam::get_gvd ( uvc::device &  device,
std::timed_mutex &  mutex,
size_t  sz,
char *  gvd,
int  gvd_cmd = (int) fw_cmd::GVD 
)

◆ get_laser_power()

void rsimpl::ivcam::get_laser_power ( const uvc::device &  device,
uint8_t &  laser_power 
)

◆ get_module_serial_string()

void rsimpl::ivcam::get_module_serial_string ( uvc::device &  device,
std::timed_mutex &  mutex,
std::string &  serial,
int  offset 
)

◆ get_motion_range()

void rsimpl::ivcam::get_motion_range ( const uvc::device &  device,
uint8_t &  motion_range 
)

◆ prepare_usb_command()

size_t rsimpl::ivcam::prepare_usb_command ( uint8_t *  request,
size_t &  requestSize,
uint32_t  op,
uint32_t  p1 = 0,
uint32_t  p2 = 0,
uint32_t  p3 = 0,
uint32_t  p4 = 0,
uint8_t *  data = 0,
size_t  dataLength = 0 
)

◆ set_accuracy()

void rsimpl::ivcam::set_accuracy ( uvc::device &  device,
uint8_t  accuracy 
)

◆ set_auto_range()

void rsimpl::ivcam::set_auto_range ( uvc::device &  device,
std::timed_mutex &  mutex,
int  enableMvR,
int16_t  minMvR,
int16_t  maxMvR,
int16_t  startMvR,
int  enableLaser,
int16_t  minLaser,
int16_t  maxLaser,
int16_t  startLaser,
int16_t  ARUpperTH,
int16_t  ARLowerTH 
)

◆ set_confidence_threshold()

void rsimpl::ivcam::set_confidence_threshold ( uvc::device &  device,
uint8_t  conf_thresh 
)

◆ set_filter_option()

void rsimpl::ivcam::set_filter_option ( uvc::device &  device,
uint8_t  filter_option 
)

◆ set_laser_power()

void rsimpl::ivcam::set_laser_power ( uvc::device &  device,
uint8_t  laser_power 
)

◆ set_motion_range()

void rsimpl::ivcam::set_motion_range ( uvc::device &  device,
uint8_t  motion_range 
)

Variable Documentation

◆ depth_xu

const uvc::extension_unit rsimpl::ivcam::depth_xu { 1, 6, 1, { 0xA55751A1, 0xF3C5, 0x4A5E, { 0x8D, 0x5A, 0x68, 0x54, 0xB8, 0xFA, 0x27, 0x16 } } }