Rokato. UdpComm

UDP通讯操作类

Constructor

new UdpComm(plug, udpIdx)

UDP通讯接口

Parameters:
NameTypeDefaultDescription
plugRktPlug

插件通信对象

udpIdxnumber0

UDP对象索引

Methods

(async) devApiV1(keyStr) → {Promise}

激活设备APIv1通讯模式

Parameters:
NameTypeDescription
keyStrstring

设备APIv1字符串密钥

Returns:

err/msg + retval

Type: 
Promise

getUdpIdx() → {number}

获取当前UDP对象索引

Returns:
Type: 
number

(async) send(host, data) → {Promise}

发送数据报

Parameters:
NameTypeDescription
hoststring

发送目标地址

datastring

十六进制数据包

Returns:

err/msg + retval(实际发送字节数)

Type: 
Promise

setUdpIdx(udpIdx)

设置切换UDP对象索引

Parameters:
NameTypeDescription
udpIdxnumber

UDP对象索引

(async) start(callback, broadcast, host) → {Promise}

启动通讯 注意重复调用仅callback更改有效,retval一定返回true

Parameters:
NameTypeDefaultDescription
callbackcallback

事件回调evt参数对象包含host(来源地址信息)/data(十六进制数据包)

broadcastbooleanfalse

是否启用UDP广播支持

hoststring0.0.0.0:0

默认绑定随机未占用端口(客户端场景) 否则为绑定指定地址与端口但端口被占用将会失败(服务端场景)

Returns:

err/msg + retval

Type: 
Promise

(async) stop() → {Promise}

停止通讯

Returns:

err/msg

Type: 
Promise