OrbbecSDK  1.0.0
函数
Device.h 文件参考

设备相关函数,包括获取创建设备,设置及获取设备属性,获取传感器等操作 更多...

#include "ObTypes.h"
Device.h 的引用(Include)关系图:
此图展示该文件直接或间接的被哪些文件引用了:

浏览源代码.

函数

uint32_t ob_device_list_device_count (ob_device_list *list, ob_error **error)
 获取设备数量 更多...
 
ob_device_info * ob_device_list_get_device_info (ob_device_list *list, uint32_t index, ob_error **error)
 获取设备信息 更多...
 
const char * ob_device_list_get_device_name (ob_device_list *list, uint32_t index, ob_error **error)
 获取指定设备名称 更多...
 
int ob_device_list_get_device_pid (ob_device_list *list, uint32_t index, ob_error **error)
 获取指定设备pid 更多...
 
int ob_device_list_get_device_vid (ob_device_list *list, uint32_t index, ob_error **error)
 获取指定设备vid 更多...
 
const char * ob_device_list_get_device_uid (ob_device_list *list, uint32_t index, ob_error **error)
 获取指定设备uid 更多...
 
ob_device * ob_get_device (ob_device_list *list, uint32_t index, ob_error **error)
 创建设备 更多...
 
void ob_delete_device (ob_device *device, ob_error **error)
 删除设备 更多...
 
void ob_delete_device_info (ob_device_info *info, ob_error **error)
 删除设备信息 更多...
 
void ob_delete_device_list (ob_device_list *list, ob_error **error)
 删除设备列表 更多...
 
ob_device_info * ob_device_get_device_info (ob_device *device, ob_error **error)
 获取设备信息 更多...
 
ob_sensor_list * ob_device_get_sensor_list (ob_device *device, ob_error **error)
 获取设备的所有传感器 更多...
 
ob_sensor * ob_device_get_sensor (ob_device *device, ob_sensor_type type, ob_error **error)
 获取设备的传感器 更多...
 
void ob_device_set_int_property (ob_device *device, ob_global_unified_property property_id, int32_t property, ob_error **error)
 设置int类型的设备属性 更多...
 
int32_t ob_device_get_int_property (ob_device *device, ob_global_unified_property property_id, ob_error **error)
 获取int类型的设备属性 更多...
 
void ob_device_set_float_property (ob_device *device, ob_global_unified_property property_id, float property, ob_error **error)
 设置float类型的设备属性 更多...
 
float ob_device_get_float_property (ob_device *device, ob_global_unified_property property_id, ob_error **error)
 获取float类型的设备属性 更多...
 
void ob_device_set_bool_property (ob_device *device, ob_global_unified_property property_id, bool property, ob_error **error)
 设置bool类型的设备属性 更多...
 
bool ob_device_get_bool_property (ob_device *device, ob_global_unified_property property_id, ob_error **error)
 获取bool类型的设备属性 更多...
 
void ob_device_set_structured_data (ob_device *device, ob_global_unified_property property_id, const void *data, uint32_t data_size, ob_error **error)
 设置结构体类型的设备属性 更多...
 
void ob_device_get_structured_data (ob_device *device, ob_global_unified_property property_id, void *data, uint32_t *data_size, ob_error **error)
 获取结构体类型的设备属性 更多...
 
bool ob_device_set_raw_data (ob_device *device, ob_global_unified_property property_id, void *data, uint32_t data_size, ob_set_data_callback cb, bool async, void *user_data, ob_error **error)
 设置raw data类型d 设备属性 更多...
 
bool ob_device_get_raw_data (ob_device *device, ob_global_unified_property property_id, ob_get_data_callback cb, bool async, void *user_data, ob_error **error)
 获取raw data类型的设备属性 更多...
 
bool ob_device_is_property_supported (ob_device *device, ob_global_unified_property property_id, ob_error **error)
 判断设备属性是否支持 更多...
 
ob_int_property_range ob_device_get_int_property_range (ob_device *device, ob_global_unified_property property_id, ob_error **error)
 获取int类型的设备属性范围 更多...
 
ob_float_property_range ob_device_get_float_property_range (ob_device *device, ob_global_unified_property property_id, ob_error **error)
 获取float类型的设备属性范围 更多...
 
ob_bool_property_range ob_device_get_bool_property_range (ob_device *device, ob_global_unified_property property_id, ob_error **error)
 获取bool类型的设备属性范围 更多...
 
void ob_device_write_ahb (ob_device *device, uint32_t reg, uint32_t mask, uint32_t value, ob_error **error)
 ahb写寄存器 更多...
 
void ob_device_read_ahb (ob_device *device, uint32_t reg, uint32_t mask, uint32_t *value, ob_error **error)
 ahb读寄存器 更多...
 
void ob_device_write_i2c (ob_device *device, uint32_t module_id, uint32_t reg, uint32_t mask, uint32_t value, ob_error **error)
 i2c写寄存器 更多...
 
void ob_device_read_i2c (ob_device *device, uint32_t module_id, uint32_t reg, uint32_t mask, uint32_t *value, ob_error **error)
 i2c读寄存器 更多...
 
bool ob_device_write_flash (ob_device *device, uint32_t offset, const void *data, uint32_t data_size, ob_set_data_callback cb, bool async, void *user_data, ob_error **error)
 设置写入Flash的属性[异步回调] 更多...
 
bool ob_device_read_flash (ob_device *device, uint32_t offset, uint32_t data_size, ob_get_data_callback cb, bool async, void *user_data, ob_error **error)
 读取Flash的属性[异步回调] 更多...
 
uint64_t ob_device_sync_device_time (ob_device *device, ob_error **error)
 同步设备时间(向设备授时,同步本地系统时间到设备) 更多...
 
bool ob_device_upgrade (ob_device *device, const char *path, ob_device_upgrade_callback callback, bool async, void *user_data, ob_error **error)
 设备固件升级 更多...
 
ob_device_state ob_device_get_device_state (ob_device *device, ob_error **error)
 获取当前设备状态 更多...
 
void ob_device_state_changed (ob_device *device, ob_device_state_callback callback, void *user_data, ob_error **error)
 设置设备状态监听 更多...
 
bool ob_device_send_file_to_destination (ob_device *device, const char *file_path, const char *dst_path, ob_file_send_callback callback, bool async, void *user_data, ob_error **error)
 发送文件到设备指定路径 更多...
 
bool ob_device_activate_authorization (ob_device *device, const char *auth_code, ob_error **error)
 验证设备授权码 更多...
 
void ob_device_write_authorization_code (ob_device *device, const char *auth_code, ob_error **error)
 写入设备授权码 更多...
 
ob_camera_intrinsic ob_device_get_camera_intrinsic (ob_device *device, ob_sensor_type sensor_type, ob_error **error)
 获取相机内参(会根据当前镜像状态返回) 更多...
 
ob_camera_distortion ob_device_get_camera_distortion (ob_device *device, ob_sensor_type sensor_type, ob_error **error)
 获取相机畸变参数(会根据当前镜像状态返回) 更多...
 
ob_d2c_transform ob_device_get_d2c_transform (ob_device *device, ob_error **error)
 获取d2c旋转矩阵(会根据当前镜像状态返回) 更多...
 
const char * ob_device_info_name (ob_device_info *info, ob_error **error)
 获取设备名 更多...
 
int ob_device_info_pid (ob_device_info *info, ob_error **error)
 获取设备pid 更多...
 
int ob_device_info_vid (ob_device_info *info, ob_error **error)
 获取设备vid 更多...
 
const char * ob_device_info_uid (ob_device_info *info, ob_error **error)
 获取设备uid 更多...
 
const char * ob_device_info_serial_number (ob_device_info *info, ob_error **error)
 获取设备序列号 更多...
 
const char * ob_device_info_firmware_version (ob_device_info *info, ob_error **error)
 获取固件版本号 更多...
 
const char * ob_device_info_usb_type (ob_device_info *info, ob_error **error)
 获取usb连接类型 更多...
 

详细描述

设备相关函数,包括获取创建设备,设置及获取设备属性,获取传感器等操作

在文件 Device.h 中定义.

函数说明

void ob_delete_device ( ob_device *  device,
ob_error **  error 
)

删除设备

参数
[in]device要删除的设备
[out]error记录错误信息
void ob_delete_device_info ( ob_device_info *  info,
ob_error **  error 
)

删除设备信息

参数
void ob_delete_device_list ( ob_device_list *  list,
ob_error **  error 
)

删除设备列表

参数
[in]list要删除的设备列表对象
[out]error记录错误信息
bool ob_device_activate_authorization ( ob_device *  device,
const char *  auth_code,
ob_error **  error 
)

验证设备授权码

参数
[in]device设备对象
[in]auth_code授权码
[out]error记录错误信息
返回
bool 激活是否成功
bool ob_device_get_bool_property ( ob_device *  device,
ob_global_unified_property  property_id,
ob_error **  error 
)

获取bool类型的设备属性

参数
[in]device设备对象
[in]property_id属性id
[out]error记录错误信息
返回
bool 返回属性值
ob_bool_property_range ob_device_get_bool_property_range ( ob_device *  device,
ob_global_unified_property  property_id,
ob_error **  error 
)

获取bool类型的设备属性范围

参数
[in]device设备对象
[in]property_id属性id
[out]error记录错误信息
返回
ob_bool_property_range 返回属性范围
ob_camera_distortion ob_device_get_camera_distortion ( ob_device *  device,
ob_sensor_type  sensor_type,
ob_error **  error 
)

获取相机畸变参数(会根据当前镜像状态返回)

参数
[in]device设备对象
[in]sensor_typesensor类型
[out]error记录错误信息
返回
ob_camera_distortion 畸变参数结构体
ob_camera_intrinsic ob_device_get_camera_intrinsic ( ob_device *  device,
ob_sensor_type  sensor_type,
ob_error **  error 
)

获取相机内参(会根据当前镜像状态返回)

参数
[in]device设备对象
[in]sensor_typesensor类型
[out]error记录错误信息
返回
ob_camera_distortion 畸变参数结构体
ob_d2c_transform ob_device_get_d2c_transform ( ob_device *  device,
ob_error **  error 
)

获取d2c旋转矩阵(会根据当前镜像状态返回)

参数
[in]device设备对象
[out]error记录错误信息
返回
ob_d2c_transform 旋转矩阵结构体
ob_device_info* ob_device_get_device_info ( ob_device *  device,
ob_error **  error 
)

获取设备信息

参数
[in]device要获取信息的设备
[out]error记录错误信息
返回
ob_device_info* 返回设备信息
ob_device_state ob_device_get_device_state ( ob_device *  device,
ob_error **  error 
)

获取当前设备状态

参数
[out]error记录错误信息
返回
ob_device_state 设备状态信息
float ob_device_get_float_property ( ob_device *  device,
ob_global_unified_property  property_id,
ob_error **  error 
)

获取float类型的设备属性

参数
[in]device设备对象
[in]property_id属性id
[out]error记录错误信息
返回
int32_t 返回属性值
ob_float_property_range ob_device_get_float_property_range ( ob_device *  device,
ob_global_unified_property  property_id,
ob_error **  error 
)

获取float类型的设备属性范围

参数
[in]device设备对象
[in]property_id属性id
[out]error记录错误信息
返回
ob_float_property_range 返回属性范围
int32_t ob_device_get_int_property ( ob_device *  device,
ob_global_unified_property  property_id,
ob_error **  error 
)

获取int类型的设备属性

参数
[in]device设备对象
[in]property_id属性id
[out]error记录错误信息
返回
int32_t 返回属性值
ob_int_property_range ob_device_get_int_property_range ( ob_device *  device,
ob_global_unified_property  property_id,
ob_error **  error 
)

获取int类型的设备属性范围

参数
[in]device设备对象
[in]property_id属性id
[out]error记录错误信息
返回
ob_int_property_range 返回属性范围
bool ob_device_get_raw_data ( ob_device *  device,
ob_global_unified_property  property_id,
ob_get_data_callback  cb,
bool  async,
void *  user_data,
ob_error **  error 
)

获取raw data类型的设备属性

参数
[in]device设备对象
[in]property_id要获取的属性id
[in]cb获取数据给返回和进度回调
[in]async是否异步执行
[in]user_data用户自定义数据,会在回调中返回
[out]error记录错误信息
ob_sensor* ob_device_get_sensor ( ob_device *  device,
ob_sensor_type  type,
ob_error **  error 
)

获取设备的传感器

参数
[in]device设备对象
[in]type要获取的传感器类型
[out]error记录错误信息
返回
ob_sensor* 返回获取的传感器
ob_sensor_list* ob_device_get_sensor_list ( ob_device *  device,
ob_error **  error 
)

获取设备的所有传感器

参数
[in]device设备对象
[out]error记录错误信息
返回
ob_sensor_list* 返回所有传感器列表
void ob_device_get_structured_data ( ob_device *  device,
ob_global_unified_property  property_id,
void *  data,
uint32_t *  data_size,
ob_error **  error 
)

获取结构体类型的设备属性

参数
[in]device设备对象
[in]property_id要获取的属性id
[out]data获取的属性数据
[out]data_size获取的属性大小
[out]error记录错误信息
const char* ob_device_info_firmware_version ( ob_device_info *  info,
ob_error **  error 
)

获取固件版本号

参数
[in]info设备信息
[out]error记录错误信息
返回
int 返回固件版本号
const char* ob_device_info_name ( ob_device_info *  info,
ob_error **  error 
)

获取设备名

参数
[in]info设备信息
[out]error记录错误信息
返回
const char* 返回设备名
int ob_device_info_pid ( ob_device_info *  info,
ob_error **  error 
)

获取设备pid

参数
[in]info设备信息
[out]error记录错误信息
返回
int 返回设备pid
const char* ob_device_info_serial_number ( ob_device_info *  info,
ob_error **  error 
)

获取设备序列号

参数
[in]info设备信息
[out]error记录错误信息
返回
const char* 返回设备序列号
const char* ob_device_info_uid ( ob_device_info *  info,
ob_error **  error 
)

获取设备uid

参数
[in]info设备信息
[out]error记录错误信息
返回
const char* 返回设备uid
const char* ob_device_info_usb_type ( ob_device_info *  info,
ob_error **  error 
)

获取usb连接类型

参数
[in]info设备信息
[out]error记录错误信息
返回
char* 返回usb连接类型
int ob_device_info_vid ( ob_device_info *  info,
ob_error **  error 
)

获取设备vid

参数
[in]info设备信息
[out]error记录错误信息
返回
int 返回设备vid
bool ob_device_is_property_supported ( ob_device *  device,
ob_global_unified_property  property_id,
ob_error **  error 
)

判断设备属性是否支持

参数
[in]device设备对象
[in]property_id属性id
[out]error记录错误信息
返回
bool 返回是否支持
uint32_t ob_device_list_device_count ( ob_device_list *  list,
ob_error **  error 
)

获取设备数量

参数
[in]list设备列表对象
[out]error记录错误信息
返回
uint32_t 返回设备数量
ob_device_info* ob_device_list_get_device_info ( ob_device_list *  list,
uint32_t  index,
ob_error **  error 
)

获取设备信息

参数
[in]list设备列表对象
[in]index设备索引
[out]error记录错误信息
返回
ob_device_info* 返回设备信息
const char* ob_device_list_get_device_name ( ob_device_list *  list,
uint32_t  index,
ob_error **  error 
)

获取指定设备名称

参数
[in]list设备列表对象
[in]index设备索引
[out]error记录错误信息
返回
const char* 返回设备名称
int ob_device_list_get_device_pid ( ob_device_list *  list,
uint32_t  index,
ob_error **  error 
)

获取指定设备pid

参数
[in]list设备列表对象
[in]index设备索引
[out]error记录错误信息
返回
int 返回设备pid
const char* ob_device_list_get_device_uid ( ob_device_list *  list,
uint32_t  index,
ob_error **  error 
)

获取指定设备uid

参数
[in]list设备列表对象
[in]index设备索引
[out]error记录错误信息
返回
const char* 返回设备uid
int ob_device_list_get_device_vid ( ob_device_list *  list,
uint32_t  index,
ob_error **  error 
)

获取指定设备vid

参数
[in]list设备列表对象
[in]index设备索引
[out]error记录错误信息
返回
int 返回设备vid
void ob_device_read_ahb ( ob_device *  device,
uint32_t  reg,
uint32_t  mask,
uint32_t *  value,
ob_error **  error 
)

ahb读寄存器

参数
[in]device设备对象
reg要读取的寄存器
mask掩码
value要读取的值
[out]error记录错误信息
bool ob_device_read_flash ( ob_device *  device,
uint32_t  offset,
uint32_t  data_size,
ob_get_data_callback  cb,
bool  async,
void *  user_data,
ob_error **  error 
)

读取Flash的属性[异步回调]

参数
[in]device设备对象
offsetflash偏移地址
data_size要读取的数据大小
cb读flash数据及进度回调
[in]async是否异步执行
[in]user_data用户自定义数据,会在回调中返回
[out]error记录错误信息
void ob_device_read_i2c ( ob_device *  device,
uint32_t  module_id,
uint32_t  reg,
uint32_t  mask,
uint32_t *  value,
ob_error **  error 
)

i2c读寄存器

参数
[in]device设备对象
module_id要读取的的i2c模块id
reg要读取的寄存器
mask掩码
value要读取的值
[out]error记录错误信息
bool ob_device_send_file_to_destination ( ob_device *  device,
const char *  file_path,
const char *  dst_path,
ob_file_send_callback  callback,
bool  async,
void *  user_data,
ob_error **  error 
)

发送文件到设备指定路径

参数
[in]device设备对象
[in]file_path源文件路径
[in]dst_path指定设备端文件接受路径
[in]callback文件发送进度回调
[in]async是否异步执行
[in]user_data用户自定义数据,会在回调中返回
[out]error记录错误信息
返回
bool 接口调用是否成功 -> 0: 失败,底层接口占用或线程占用;1: 成功
void ob_device_set_bool_property ( ob_device *  device,
ob_global_unified_property  property_id,
bool  property,
ob_error **  error 
)

设置bool类型的设备属性

参数
[in]device设备对象
[in]property_id要设置的属性id
[in]property要设置的属性值
[out]error记录错误信息
void ob_device_set_float_property ( ob_device *  device,
ob_global_unified_property  property_id,
float  property,
ob_error **  error 
)

设置float类型的设备属性

参数
[in]device设备对象
[in]property_id要设置的属性id
[in]property要设置的属性值
[out]error记录错误信息
void ob_device_set_int_property ( ob_device *  device,
ob_global_unified_property  property_id,
int32_t  property,
ob_error **  error 
)

设置int类型的设备属性

参数
[in]device设备对象
[in]property_id要设置的属性id
[in]property要设置的属性值
[out]error记录错误信息
bool ob_device_set_raw_data ( ob_device *  device,
ob_global_unified_property  property_id,
void *  data,
uint32_t  data_size,
ob_set_data_callback  cb,
bool  async,
void *  user_data,
ob_error **  error 
)

设置raw data类型d 设备属性

参数
[in]device设备对象
[in]property_id要设置的属性id
[in]data要设置的属性数据
[in]data_size要设置的属性大小
[in]cb设置进度回调
[in]async是否异步执行
[in]user_data用户自定义数据,会在回调中返回
[out]error记录错误信息
void ob_device_set_structured_data ( ob_device *  device,
ob_global_unified_property  property_id,
const void *  data,
uint32_t  data_size,
ob_error **  error 
)

设置结构体类型的设备属性

参数
[in]device设备对象
[in]property_id要设置的属性id
[in]data要设置的属性数据
[in]data_size要设置的属性大小
[out]error记录错误信息
void ob_device_state_changed ( ob_device *  device,
ob_device_state_callback  callback,
void *  user_data,
ob_error **  error 
)

设置设备状态监听

参数
[in]device设备对象
[in]callback设备状态发生改变时的回调
[in]user_data用户自定义数据,会在回调中返回
[out]error记录错误信息
uint64_t ob_device_sync_device_time ( ob_device *  device,
ob_error **  error 
)

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

参数
[in]device设备对象
[out]uint64_t命令往返时间延时(round trip time, rtt)
[out]error记录错误信息
bool ob_device_upgrade ( ob_device *  device,
const char *  path,
ob_device_upgrade_callback  callback,
bool  async,
void *  user_data,
ob_error **  error 
)

设备固件升级

参数
[in]device设备对象
[in]path固件路径
[in]callback固件升级进度回调
[in]async是否异步执行
[in]user_data用户自定义数据,会在回调中返回
[out]error记录错误信息
返回
bool 接口调用是否成功 -> 0: 失败,底层接口占用或线程占用;1: 成功
void ob_device_write_ahb ( ob_device *  device,
uint32_t  reg,
uint32_t  mask,
uint32_t  value,
ob_error **  error 
)

ahb写寄存器

参数
[in]device设备对象
reg要写入的寄存器
mask掩码
value要写入的值
[out]error记录错误信息
void ob_device_write_authorization_code ( ob_device *  device,
const char *  auth_code,
ob_error **  error 
)

写入设备授权码

参数
[in]device设备对象
[in]auth_code授权码
[out]error记录错误信息
bool ob_device_write_flash ( ob_device *  device,
uint32_t  offset,
const void *  data,
uint32_t  data_size,
ob_set_data_callback  cb,
bool  async,
void *  user_data,
ob_error **  error 
)

设置写入Flash的属性[异步回调]

参数
[in]device设备对象
offsetflash偏移地址
data要写入的属性数据
data_size要写入的属性大小
cb写进度回调
[in]async是否异步执行
[in]user_data用户自定义数据,会在回调中返回
[out]error记录错误信息
void ob_device_write_i2c ( ob_device *  device,
uint32_t  module_id,
uint32_t  reg,
uint32_t  mask,
uint32_t  value,
ob_error **  error 
)

i2c写寄存器

参数
[in]device设备对象
module_id要写入的i2c模块id
reg要写入的寄存器
mask掩码
value要写入的值
[out]error记录错误信息
ob_device* ob_get_device ( ob_device_list *  list,
uint32_t  index,
ob_error **  error 
)

创建设备

注意
如果设备有在其他地方被获取创建,重复获取将会返回错误
参数
[in]list设备列表对象
index要创建设备的索引
[out]error记录错误信息
返回
ob_device* 返回创建的设备