ob2command.h 文件参考

#include "ob2types.h"

浏览源代码.

函数
uint32_t	ob2_device_get_supported_command_count (ob2_device_t device_handle, ob2_status_t *status)
	获取设备支持的命令个数 更多...
ob2_command_info_t	ob2_device_get_supported_command_info (ob2_device_t device_handle, uint32_t index, ob2_status_t *status)
	通过索引号获取设备支持的命令信息 更多...
ob2_command_info_t	ob2_device_get_supported_command_info_by_id (ob2_device_t device_handle, ob2_command_id_t command_id, ob2_status_t *status)
	通过命令 id 获取设备支持的命令信息 更多...
bool	ob2_device_check_command_access_permission (ob2_device_t device_handle, ob2_command_id_t command_id, ob2_access_permission_t permission, ob2_status_t *status)
	检查设备命令访问权限 更多...
bool	ob2_device_get_bool_property_value (ob2_device_t device_handle, ob2_command_id_t command_id, ob2_status_t *status)
	获取设备布尔类型属性值 更多...
void	ob2_device_set_bool_property_value (ob2_device_t device_handle, ob2_command_id_t command_id, bool value, ob2_status_t *status)
	设置设备布尔类型属性值 更多...
bool	ob2_device_get_bool_property_default_value (ob2_device_t device_handle, ob2_command_id_t command_id, ob2_status_t *status)
	设置设备布尔类型属性默认值 更多...
int	ob2_device_get_int_property_value (ob2_device_t device_handle, ob2_command_id_t command_id, ob2_status_t *status)
	获取设备整型类型属性值 更多...
void	ob2_device_set_int_property_value (ob2_device_t device_handle, ob2_command_id_t command_id, int value, ob2_status_t *status)
	设置设备整型类型属性值 更多...
ob2_int_property_capability_t	ob2_device_get_int_property_capability (ob2_device_t device_handle, ob2_command_id_t command_id, ob2_status_t *status)
	获取设备整型类型属性能力 更多...
float	ob2_device_get_float_property_value (ob2_device_t device_handle, ob2_command_id_t command_id, ob2_status_t *status)
	获取设备浮点类型属性值 更多...
void	ob2_device_set_float_property_value (ob2_device_t device_handle, ob2_command_id_t command_id, float value, ob2_status_t *status)
	设置设备浮点类型属性值 更多...
ob2_float_property_capability_t	ob2_device_get_float_property_capability (ob2_device_t device_handle, ob2_command_id_t command_id, ob2_status_t *status)
	获取设备浮点类型属性能力 更多...
ob2_data_bundle_t *	ob2_device_get_structured_data (ob2_device_t device_handle, ob2_command_id_t command_id, ob2_status_t *status)
	获取结构体类型数据 更多...
void	ob2_device_update_structured_data (ob2_device_t device_handle, ob2_command_id_t command_id, ob2_data_bundle_t *data_bundle, ob2_status_t *status)
	设置结构体类型数据 更多...
void	ob2_data_bundle_release (ob2_data_bundle_t *data_bundle, ob2_status_t *status)
	释放数据捆 更多...

函数说明

ob2_device_get_supported_command_count()

uint32_t ob2_device_get_supported_command_count	(	ob2_device_t	device_handle,
		ob2_status_t *	status
	)

获取设备支持的命令个数

参数

[in]	device_handle	设备句柄
[out]	status	返回函数调用状态

返回

uint32_t 返回设备支持的命令个数

被这些函数引用 ob2::device::get_supported_command_info_list().

ob2_device_get_supported_command_info()

ob2_command_info_t ob2_device_get_supported_command_info	(	ob2_device_t	device_handle,
		uint32_t	index,
		ob2_status_t *	status
	)

通过索引号获取设备支持的命令信息

注意

设备支持的控制命令指该设备支持读和写任一访问权限的命令

索引号 @index 范围为 [0, count-1] (count 通过 ob2_device_get_supported_command_count 返回），传入范围外的数值 将通过 @status 返回::OB2_STATUS_LOGIC_ERROR

参数

[in]	device_handle	设备句柄
[in]	index	命令索引号
[out]	status	返回函数调用状态

返回

ob2_command_info_t 返回命令信息

被这些函数引用 ob2::device::get_supported_command_info_list().

ob2_device_get_supported_command_info_by_id()

ob2_command_info_t ob2_device_get_supported_command_info_by_id	(	ob2_device_t	device_handle,
		ob2_command_id_t	command_id,
		ob2_status_t *	status
	)

通过命令 id 获取设备支持的命令信息

注意

@command_id 需要是设备支持的 id，如果是不支持的，将通过 @status 返回::OB2_STATUS_LOGIC_ERROR 。

参数

[in]	device_handle	设备句柄
[in]	command_id	命令 id
[out]	status	返回函数调用状态

返回

ob2_command_info_t 返回命令信息

被这些函数引用 ob2::device::get_supported_command_info_by_id().

ob2_device_check_command_access_permission()

bool ob2_device_check_command_access_permission	(	ob2_device_t	device_handle,
		ob2_command_id_t	command_id,
		ob2_access_permission_t	permission,
		ob2_status_t *	status
	)

检查设备命令访问权限

参数

[in]	device_handle	设备句柄
[in]	command_id	命令 id
[in]	permission	权限类型
[out]	status	返回函数调用状态

返回

true 该设备支持该访问权限

false 该设备不支持该访问权限

被这些函数引用 ob2::device::check_command_access_permission().

ob2_device_get_bool_property_value()

bool ob2_device_get_bool_property_value	(	ob2_device_t	device_handle,
		ob2_command_id_t	command_id,
		ob2_status_t *	status
	)

获取设备布尔类型属性值

布尔类型属性是设备命令的一种

注意

如果该设备不支持 @command_id 指定命令的读取权限，将通过 @status 返回::OB2_STATUS_LOGIC_ERROR 。

参数

[in]	device_handle	设备句柄
[in]	command_id	设备命令 id
[out]	status	返回函数调用状态

返回

bool 返回属性值

被这些函数引用 ob2::device::get_bool_property_value().

ob2_device_set_bool_property_value()

void ob2_device_set_bool_property_value	(	ob2_device_t	device_handle,
		ob2_command_id_t	command_id,
		bool	value,
		ob2_status_t *	status
	)

设置设备布尔类型属性值

注意

如果该设备不支持 @command_id 指定命令的写权限，将通过 @status 返回::OB2_STATUS_LOGIC_ERROR 。

参数

[in]	device_handle	设备句柄
[in]	value	需要设置的值
[in]	command_id	设备命令 id
[out]	status	返回函数调用状态

被这些函数引用 ob2::device::set_bool_property_value().

ob2_device_get_bool_property_default_value()

bool ob2_device_get_bool_property_default_value	(	ob2_device_t	device_handle,
		ob2_command_id_t	command_id,
		ob2_status_t *	status
	)

设置设备布尔类型属性默认值

注意

如果该设备不支持 @command_id 指定命令的写读权限，将通过 @status 返回::OB2_STATUS_LOGIC_ERROR 。

参数

[in]	device_handle	设备句柄
[in]	command_id	设备命令 id
[out]	status	返回函数调用状态

返回

bool 返回属性默认值

被这些函数引用 ob2::device::get_bool_property_default_value().

ob2_device_get_int_property_value()

int ob2_device_get_int_property_value	(	ob2_device_t	device_handle,
		ob2_command_id_t	command_id,
		ob2_status_t *	status
	)

获取设备整型类型属性值

整型类型属性是设备命令的一种

注意

如果该设备不支持 @command_id 指定命令的读取权限，将通过 @status 返回::OB2_STATUS_LOGIC_ERROR 。

参数

[in]	device_handle	设备句柄
[in]	command_id	设备命令 id
[out]	status	返回函数调用状态

返回

int 返回属性值

被这些函数引用 ob2::device::get_int_property_value().

ob2_device_set_int_property_value()

void ob2_device_set_int_property_value	(	ob2_device_t	device_handle,
		ob2_command_id_t	command_id,
		int	value,
		ob2_status_t *	status
	)

设置设备整型类型属性值

注意

如果该设备不支持 @command_id 指定命令的写权限，将通过 @status 返回::OB2_STATUS_LOGIC_ERROR 。

参数

[in]	device_handle	设备句柄
[in]	value	需要设置的值
[in]	command_id	设备命令 id
[out]	status	返回函数调用状态

被这些函数引用 ob2::device::set_int_property_value().

ob2_device_get_int_property_capability()

ob2_int_property_capability_t ob2_device_get_int_property_capability	(	ob2_device_t	device_handle,
		ob2_command_id_t	command_id,
		ob2_status_t *	status
	)

获取设备整型类型属性能力

属性能力包括其最大值、最小值、步进值、默认值

注意

如果该设备不支持 @command_id 指定命令的读取权限，将通过 @status 返回::OB2_STATUS_LOGIC_ERROR 。

参数

[in]	device_handle	设备句柄
[in]	command_id	设备命令 id
[out]	status	返回函数调用状态

返回

ob2_int_property_capability_t 返回属性能力

被这些函数引用 ob2::device::get_int_property_capability().

ob2_device_get_float_property_value()

float ob2_device_get_float_property_value	(	ob2_device_t	device_handle,
		ob2_command_id_t	command_id,
		ob2_status_t *	status
	)

获取设备浮点类型属性值

浮点类型属性是设备命令的一种

注意

如果该设备不支持 @command_id 指定命令的读取权限，将通过 @status 返回::OB2_STATUS_LOGIC_ERROR 。

参数

[in]	device_handle	设备句柄
[in]	command_id	设备命令 id
[out]	status	返回函数调用状态

返回

float 返回属性值

被这些函数引用 ob2::device::get_float_property_value().

ob2_device_set_float_property_value()

void ob2_device_set_float_property_value	(	ob2_device_t	device_handle,
		ob2_command_id_t	command_id,
		float	value,
		ob2_status_t *	status
	)

设置设备浮点类型属性值

注意

如果该设备不支持 @command_id 指定命令的写权限，将通过 @status 返回::OB2_STATUS_LOGIC_ERROR 。

参数

[in]	device_handle	设备句柄
[in]	value	需要设置的值
[in]	command_id	设备命令 id
[out]	status	返回函数调用状态

被这些函数引用 ob2::device::set_float_property_value().

ob2_device_get_float_property_capability()

ob2_float_property_capability_t ob2_device_get_float_property_capability	(	ob2_device_t	device_handle,
		ob2_command_id_t	command_id,
		ob2_status_t *	status
	)

获取设备浮点类型属性能力

属性能力包括其最大值、最小值、步进值、默认值

注意

如果该设备不支持 @command_id 指定命令的读取权限，将通过 @status 返回::OB2_STATUS_LOGIC_ERROR 。

参数

[in]	device_handle	设备句柄
[in]	command_id	设备命令 id
[out]	status	返回函数调用状态

返回

ob2_float_property_capability_t 返回属性能力

被这些函数引用 ob2::device::get_float_property_capability().

ob2_device_get_structured_data()

ob2_data_bundle_t * ob2_device_get_structured_data	(	ob2_device_t	device_handle,
		ob2_command_id_t	command_id,
		ob2_status_t *	status
	)

获取结构体类型数据

结构体类型数据命令是设备命令中的一种

注意

如果该设备不支持 @command_id 指定命令的读取权限，将通过 @status 返回::OB2_STATUS_LOGIC_ERROR 。

如果返回的数据捆不在需要使用，需要调用 ob2_data_bundle_release 接口释放，否则会导致内存泄漏。

参数

[in]	device_handle	设备句柄
[in]	command_id	设备命令 id
[out]	status	返回函数调用状态

返回

ob2_data_bundle_t* 返回结构体类型数据捆（包含该结构体类似数据的多组数据）

被这些函数引用 ob2::device::get_structured_data().

ob2_device_update_structured_data()

void ob2_device_update_structured_data	(	ob2_device_t	device_handle,
		ob2_command_id_t	command_id,
		ob2_data_bundle_t *	data_bundle,
		ob2_status_t *	status
	)

设置结构体类型数据

结构体类型数据命令是设备命令中的一种

参数

[in]	device_handle	设备句柄
[in]	command_id	设备命令 id
[in]	data_bundle	需要设置的数据
[out]	status	返回函数调用状态

被这些函数引用 ob2::device::update_structured_data().

ob2_data_bundle_release()

void ob2_data_bundle_release	(	ob2_data_bundle_t *	data_bundle,
		ob2_status_t *	status
	)

释放数据捆

参数

[in]	data_bundle	需要释放的数据捆
[out]	status	返回函数调用状态

被这些函数引用 ob2::device::release_data_bundle().