rm::OPTLightController类 参考

OPT 奥普特光源控制器 更多...

#include <rmvl/light/opt_light_control.h>

rm::OPTLightController 的协作图:

Public 成员函数
	OPTLightController ()=default
	构造新 OPTLightController 对象
	OPTLightController (const OPTLightController &)=delete
	禁止从 OPTLightController 对象复制构造
	OPTLightController (OPTLightController &&obj)=default
	移动 OPTLightController 对象
	~OPTLightController ()
bool	connect (const LightIpConfig &ip_config)
	使用 IP 地址创建 EtherNet 以太网连接
bool	connect (std::string_view SN)
	使用设备序列号创建 EtherNet 以太网连接
bool	disconnect ()
	断开已存在网口的连接
bool	openChannels (const std::vector< int > &channels)
	打开指定通道
bool	openAllChannels ()
	打开全部通道
bool	closeChannels (const std::vector< int > &channels)
	关闭指定通道
bool	closeAllChannels ()
	关闭全部通道
int	getIntensity (int channel) const
	获取指定通道的光源亮度
bool	setIntensity (int channel, int intensity)
	设置指定通道的光源亮度
bool	trigger (int channel, int time) const
	光源控制器软触发指定通道

详细描述

OPT 奥普特光源控制器

构造及析构函数说明

OPTLightController() [1/3]

rm::OPTLightController::OPTLightController ( )

default

Python:
	rm.OPTLightController(		) ->	<OPTLightController object>

构造新 OPTLightController 对象

OPTLightController() [2/3]

rm::OPTLightController::OPTLightController ( const OPTLightController & )

delete

Python:
	rm.OPTLightController(		) ->	<OPTLightController object>

禁止从 OPTLightController 对象复制构造

OPTLightController() [3/3]

rm::OPTLightController::OPTLightController ( OPTLightController && obj )

default

Python:
	rm.OPTLightController(		) ->	<OPTLightController object>

移动 OPTLightController 对象

~OPTLightController()

rm::OPTLightController::~OPTLightController ( )

inline

成员函数说明

closeAllChannels()

bool rm::OPTLightController::closeAllChannels

(

)

Python:
	rm.OPTLightController.closeAllChannels(		) ->	<Success ?>

关闭全部通道

返回

指定通道是否关闭成功？

closeChannels()

bool rm::OPTLightController::closeChannels

(

const std::vector< int > &

channels

)

Python:
	rm.OPTLightController.closeChannels(	channels	) ->	<Success ?>

关闭指定通道

参数

[in]

channels

要关闭的通道的索引组成的 std::vector ，范围: [1 ~ 32]（十进制格式）

返回

指定通道是否关闭成功？

connect() [1/2]

bool rm::OPTLightController::connect

(

const LightIpConfig &

ip_config

)

Python:
	rm.OPTLightController.connect(	ip_config	) ->	<Success ?>
	rm.OPTLightController.connect(	SN	) ->	<Success ?>

使用 IP 地址创建 EtherNet 以太网连接

参数

[in]

ip_config

IP 配置信息

返回

连接是否成功建立？

connect() [2/2]

bool rm::OPTLightController::connect

(

std::string_view

SN

)

Python:
	rm.OPTLightController.connect(	ip_config	) ->	<Success ?>
	rm.OPTLightController.connect(	SN	) ->	<Success ?>

使用设备序列号创建 EtherNet 以太网连接

参数

[in]

SN

设备序列号

返回

连接是否成功建立？

disconnect()

bool rm::OPTLightController::disconnect

(

)

Python:
	rm.OPTLightController.disconnect(		) ->	<Success ?>

断开已存在网口的连接

getIntensity()

int rm::OPTLightController::getIntensity

(

int

channel

)

const

Python:
	rm.OPTLightController.getIntensity(	channel	) ->	intensity

获取指定通道的光源亮度

参数

[in]

channel

指定通道

返回

若读取成功，返回 \([0, 255]\) 的值，否则返回 \(-1\)

openAllChannels()

bool rm::OPTLightController::openAllChannels

(

)

Python:
	rm.OPTLightController.openAllChannels(		) ->	<Success ?>

打开全部通道

返回

指定通道是否打开成功？

openChannels()

bool rm::OPTLightController::openChannels

(

const std::vector< int > &

channels

)

Python:
	rm.OPTLightController.openChannels(	channels	) ->	<Success ?>

打开指定通道

参数

[in]

channels

要打开的通道的索引组成的 std::vector ，范围: [1 ~ 32]（十进制格式）

返回

指定通道是否打开成功？

setIntensity()

bool rm::OPTLightController::setIntensity	(	int	channel,
		int	intensity )

Python:
	rm.OPTLightController.setIntensity(	channel, intensity	) ->	<Success ?>

设置指定通道的光源亮度

参数

[in]	channel	指定通道
[in]	intensity	指定通道的光源亮度

返回

是否设置成功？

trigger()

bool rm::OPTLightController::trigger	(	int	channel,
		int	time ) const

Python:
	rm.OPTLightController.trigger(	channel, time	) ->	<Success ?>

光源控制器软触发指定通道

参数

[in]	channel	指定通道
[in]	time	触发时间，单位: 10ms

返回

是否成功触发？

---

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

• rmvl/light/opt_light_control.h