OrbbecSDK  1.0.0
Public 成员函数 | 友元 | 所有成员列表
ob::Device类 参考

Public 成员函数

 Device (std::unique_ptr< DeviceImpl > impl)
 描述RGBD相机的实体,代表一个具体型号的RGBD相机
 
std::shared_ptr< DeviceInfo > getDeviceInfo ()
 获取设备信息 更多...
 
std::shared_ptr< SensorList > getSensorList ()
 获取设备传感器列表 更多...
 
std::shared_ptr< Sensor > getSensor (OBSensorType type)
 获取指定类型传感器 如果设备没有打开传感器,在SDK内部会自动打开设备并返回实例 更多...
 
void setIntProperty (OBGlobalUnifiedProperty propertyId, int32_t property)
 设置int类型的设备属性 更多...
 
void setFloatProperty (OBGlobalUnifiedProperty propertyId, float property)
 设置float类型的设备属性 更多...
 
void setBoolProperty (OBGlobalUnifiedProperty propertyId, bool property)
 设置bool类型的设备属性 更多...
 
int32_t getIntProperty (OBGlobalUnifiedProperty propertyId)
 获取int类型的设备属性 更多...
 
float getFloatProperty (OBGlobalUnifiedProperty propertyId)
 获取float类型的设备属性 更多...
 
bool getBoolProperty (OBGlobalUnifiedProperty propertyId)
 获取bool类型的设备属性 更多...
 
OBIntPropertyRange getIntPropertyRange (OBGlobalUnifiedProperty propertyId)
 获取int类型的设备属性的范围(包括当前值和默认值) 更多...
 
OBFloatPropertyRange getFloatPropertyRange (OBGlobalUnifiedProperty propertyId)
 获取float类型的设备属性的范围(包括当前值和默认值) 更多...
 
OBBoolPropertyRange getBoolPropertyRange (OBGlobalUnifiedProperty propertyId)
 获取bool类型的设备属性的范围(包括当前值和默认值) 更多...
 
void writeAHB (uint32_t reg, uint32_t mask, uint32_t value)
 AHB写寄存器 更多...
 
void readAHB (uint32_t reg, uint32_t mask, uint32_t *value)
 AHB读寄存器 更多...
 
void writeI2C (uint32_t moduleId, uint32_t reg, uint32_t mask, uint32_t value)
 I2C写寄存器 更多...
 
void readI2C (uint32_t moduleId, uint32_t reg, uint32_t mask, uint32_t *value)
 I2C读寄存器 更多...
 
bool writeFlash (uint32_t offset, const void *data, uint32_t dataSize, SetDataCallback callback, bool async=false)
 设置写入Flash的属性 更多...
 
bool readFlash (uint32_t offset, uint32_t dataSize, GetDataCallback callback, bool async=false)
 读取Flash的属性 更多...
 
bool setRawData (OBGlobalUnifiedProperty propertyId, const void *data, uint32_t dataSize, SetDataCallback callback, bool async=false)
 设置raw data类型的设备属性数据[异步回调] 更多...
 
bool getRawData (OBGlobalUnifiedProperty propertyId, GetDataCallback callback, bool async=false)
 获取raw data类型的设备属性数据[异步回调] 更多...
 
void setStructuredData (OBGlobalUnifiedProperty propertyId, const void *data, uint32_t dataSize)
 设置raw data类型的设备属性 更多...
 
void getStructuredData (OBGlobalUnifiedProperty propertyId, void *data, uint32_t *dataSize)
 获取raw data类型的设备属性 更多...
 
bool isPropertySupported (OBGlobalUnifiedProperty propertyId)
 判断设备的属性是否支持 更多...
 
uint64_t syncDeviceTime ()
 同步设备时间(向设备授时,同步本地系统时间到设备) 更多...
 
bool deviceUpgrade (const char *filePath, DeviceUpgradeCallback callback, bool async=true)
 升级设备固件 更多...
 
bool sendFile (const char *filePath, const char *dstPath, SendFileCallback callback, bool async=true)
 发送文件到设备端指定路径[异步回调] 更多...
 
OBDeviceState getDeviceState ()
 获取当前设备状态 更多...
 
void setDeviceStateChangedCallback (DeviceStateChangedCallback callback)
 设置设备状态改变回调函数 更多...
 
bool activateAuthorization (const char *authCode)
 验证设备授权码 更多...
 
void writeAuthorizationCode (const char *authCodeStr)
 写入设备授权码 更多...
 
OBCameraIntrinsic getCameraIntrinsic (OBSensorType sensorType)
 获取当前内参(会根据sensor镜像状态做转换) 更多...
 
OBCameraDistortion getCameraDistortion (OBSensorType sensorType)
 获取当前去畸变参数(会根据sensor镜像状态做转换) 更多...
 
OBD2CTransform getD2CTransform ()
 获取旋转矩阵(会根据sensor镜像状态做转换) 更多...
 

友元

class Pipeline
 

详细描述

在文件 Device.hpp 第 22 行定义.

成员函数说明

bool ob::Device::activateAuthorization ( const char *  authCode)

验证设备授权码

参数
authCode授权码
返回
bool 激活是否成功
bool ob::Device::deviceUpgrade ( const char *  filePath,
DeviceUpgradeCallback  callback,
bool  async = true 
)

升级设备固件

参数
filePath固件的路径
callback固件升级进度及状态回调
async是否异步执行
返回
接口调用是否成功
bool ob::Device::getBoolProperty ( OBGlobalUnifiedProperty  propertyId)

获取bool类型的设备属性

参数
propertyId属性id
返回
bool 获取的属性数据
OBBoolPropertyRange ob::Device::getBoolPropertyRange ( OBGlobalUnifiedProperty  propertyId)

获取bool类型的设备属性的范围(包括当前值和默认值)

参数
propertyId属性id
返回
OBBoolPropertyRange 属性的范围
OBCameraDistortion ob::Device::getCameraDistortion ( OBSensorType  sensorType)

获取当前去畸变参数(会根据sensor镜像状态做转换)

参数
sensorType需要获取内参的Sensor
返回
OBCameraDistortion 去畸变参数结构体
OBCameraIntrinsic ob::Device::getCameraIntrinsic ( OBSensorType  sensorType)

获取当前内参(会根据sensor镜像状态做转换)

参数
sensorType需要获取内参的Sensor
返回
OBCameraIntrinsic 内参结构体
OBD2CTransform ob::Device::getD2CTransform ( )

获取旋转矩阵(会根据sensor镜像状态做转换)

返回
Transform 旋转矩阵结构体
std::shared_ptr< DeviceInfo > ob::Device::getDeviceInfo ( )

获取设备信息

返回
std::shared_ptr<DeviceInfo> 返回设备的信息
OBDeviceState ob::Device::getDeviceState ( )

获取当前设备状态

返回
DEVICE_STATE 设备状态信息
float ob::Device::getFloatProperty ( OBGlobalUnifiedProperty  propertyId)

获取float类型的设备属性

参数
propertyId属性id
返回
float 获取的属性数据
OBFloatPropertyRange ob::Device::getFloatPropertyRange ( OBGlobalUnifiedProperty  propertyId)

获取float类型的设备属性的范围(包括当前值和默认值)

参数
propertyId属性id
返回
OBFloatPropertyRange 属性的范围
int32_t ob::Device::getIntProperty ( OBGlobalUnifiedProperty  propertyId)

获取int类型的设备属性

参数
propertyId属性id
返回
int32_t 获取的属性数据
OBIntPropertyRange ob::Device::getIntPropertyRange ( OBGlobalUnifiedProperty  propertyId)

获取int类型的设备属性的范围(包括当前值和默认值)

参数
propertyId属性id
返回
OBIntPropertyRange 属性的范围
bool ob::Device::getRawData ( OBGlobalUnifiedProperty  propertyId,
GetDataCallback  callback,
bool  async = false 
)

获取raw data类型的设备属性数据[异步回调]

参数
propertyId属性id
data获取的属性数据
dataSize获取的属性大小
callback获取返回的数据及进度回调
async是否异步执行
返回
接口调用是否成功
std::shared_ptr< Sensor > ob::Device::getSensor ( OBSensorType  type)

获取指定类型传感器 如果设备没有打开传感器,在SDK内部会自动打开设备并返回实例

返回
std::shared_ptr<Sensor> 返回传感器示例,如果设备没有该设备,返回nullptr
std::shared_ptr< SensorList > ob::Device::getSensorList ( )

获取设备传感器列表

返回
std::shared_ptr<SensorList> 返回传感器列表
void ob::Device::getStructuredData ( OBGlobalUnifiedProperty  propertyId,
void *  data,
uint32_t *  dataSize 
)

获取raw data类型的设备属性

参数
propertyId属性id
data获取的属性数据
dataSize获取的属性大小
bool ob::Device::isPropertySupported ( OBGlobalUnifiedProperty  propertyId)

判断设备的属性是否支持

参数
propertyId属性id
返回
true 支持该属性
false 不支持该属性
void ob::Device::readAHB ( uint32_t  reg,
uint32_t  mask,
uint32_t *  value 
)

AHB读寄存器

参数
reg要读取的寄存器
mask要读取的掩码
value读取的值返回
bool ob::Device::readFlash ( uint32_t  offset,
uint32_t  dataSize,
GetDataCallback  callback,
bool  async = false 
)

读取Flash的属性

参数
offsetflash 偏移地址
data读取的属性数据
dataSize获取的属性大小
callback读flash返回的数据及进度回调
async是否异步执行
返回
接口调用是否成功
void ob::Device::readI2C ( uint32_t  moduleId,
uint32_t  reg,
uint32_t  mask,
uint32_t *  value 
)

I2C读寄存器

参数
reg要读取的I2C模块ID
reg要读取的寄存器
mask要读取的掩码
value读取的值返回
bool ob::Device::sendFile ( const char *  filePath,
const char *  dstPath,
SendFileCallback  callback,
bool  async = true 
)

发送文件到设备端指定路径[异步回调]

参数
filePath原文件路径
dstPath设备端接受保存路径
callback文件传输回调
async是否异步执行
返回
接口调用是否成功
void ob::Device::setBoolProperty ( OBGlobalUnifiedProperty  propertyId,
bool  property 
)

设置bool类型的设备属性

参数
propertyId属性id
property要设置的属性
void ob::Device::setDeviceStateChangedCallback ( DeviceStateChangedCallback  callback)

设置设备状态改变回调函数

参数
callback设备状态改变(如,由于温度过高自动降低帧率或关流等)时触发的回调函数
void ob::Device::setFloatProperty ( OBGlobalUnifiedProperty  propertyId,
float  property 
)

设置float类型的设备属性

参数
propertyId属性id
property要设置的属性
void ob::Device::setIntProperty ( OBGlobalUnifiedProperty  propertyId,
int32_t  property 
)

设置int类型的设备属性

参数
propertyId属性id
property要设置的属性
bool ob::Device::setRawData ( OBGlobalUnifiedProperty  propertyId,
const void *  data,
uint32_t  dataSize,
SetDataCallback  callback,
bool  async = false 
)

设置raw data类型的设备属性数据[异步回调]

参数
propertyId属性id
data要设置的属性数据
dataSize要设置的属性数据大小
callbackrawdata设置进度回调
async是否异步执行
返回
接口调用是否成功
void ob::Device::setStructuredData ( OBGlobalUnifiedProperty  propertyId,
const void *  data,
uint32_t  dataSize 
)

设置raw data类型的设备属性

参数
propertyId属性id
data要设置的属性数据
dataSize要设置的属性大小
uint64_t ob::Device::syncDeviceTime ( )

同步设备时间(向设备授时,同步本地系统时间到设备)

返回
uint64_t 命令往返时间延时(round trip time, rtt)
void ob::Device::writeAHB ( uint32_t  reg,
uint32_t  mask,
uint32_t  value 
)

AHB写寄存器

参数
reg要写入的寄存器
mask要写入的掩码
value要写入的值
void ob::Device::writeAuthorizationCode ( const char *  authCodeStr)

写入设备授权码

参数
authCode授权码
bool ob::Device::writeFlash ( uint32_t  offset,
const void *  data,
uint32_t  dataSize,
SetDataCallback  callback,
bool  async = false 
)

设置写入Flash的属性

参数
offsetflash 偏移地址
data要写入的属性数据
dataSize要写入的属性大小
callback写flash进度回调
async是否异步执行
返回
接口调用是否成功
void ob::Device::writeI2C ( uint32_t  moduleId,
uint32_t  reg,
uint32_t  mask,
uint32_t  value 
)

I2C写寄存器

参数
reg要写入的I2C模块ID
reg要写入的寄存器
mask要写入的掩码
value要写入的值

该类的文档由以下文件生成: