com.agora.iotsdk20.IDeviceMgr接口 参考

设备管理接口。

成员函数说明

acceptDevice()

int com.agora.iotsdk20.IDeviceMgr.acceptDevice	(	final String	deviceName,
		final String	order
	)

接收来自其他账号的设备分享。

成功接收后，SDK 会触发 onAcceptDevcieDone 回调。

参数

参数名	描述
deviceName	设备名字。
order	分享口令。

返回值

错误码，详见 ErrCode。

addDevice()

int com.agora.iotsdk20.IDeviceMgr.addDevice	(	String	productNumber,
		String	deviceID
	)

添加设备。

成功添加设备后，SDK 会触发 onDeviceAddDone 回调。

参数

参数名	描述
productNumber	作为产品唯一标识的数字。
deviceID	设备唯一 ID，即设备的 MAC 地址。

返回值

错误码，详见 ErrCode。

deleteShareMsg()

int com.agora.iotsdk20.IDeviceMgr.deleteShareMsg

(

long

messageId

)

删除单个分享消息。

成功删除后，SDK 会触发 onDeleteShareMsgDone 回调。

参数

参数名	描述
messageId	要删除的分享消息 ID。

返回值

错误码，详见 ErrCode。

deshareDevice()

int com.agora.iotsdk20.IDeviceMgr.deshareDevice

(

final IotOutSharer

outSharer

)

取消设备的分享权限。

成功取消分享后，SDK 会触发 onDeshareDeviceDone 回调。

参数

参数名	描述
outSharer	取消分享出去的设备，详见 IotOutSharer。

返回值

错误码，详见 ErrCode。

getBindDevList()

List< IotDevice > com.agora.iotsdk20.IDeviceMgr.getBindDevList

(

)

获取当前绑定的设备列表。

该方法直接返回缓存的绑定设备列表，不从服务器查询。为确保数据可靠，请至少通过 queryAllDevices 查询过一次设备列表。

返回值

绑定设备列表，详见 IotDevice。

getDeviceProperty()

int com.agora.iotsdk20.IDeviceMgr.getDeviceProperty

(

IotDevice

iotDevice

)

获取设备属性。

成功获取后，SDK 会触发 onGetPropertyDone 和 onReceivedDeviceProperty 回调。

参数

参数名	描述
iotDevice	要获取属性的设备，详见 IotDevice。

返回值

错误码，详见 ErrCode。

getMcuUpgradeStatus()

int com.agora.iotsdk20.IDeviceMgr.getMcuUpgradeStatus	(	IotDevice	iotDevice,
		long	upgradeId
	)

获取设备升级，触发 onUpgradeStatusDone 回调。

参数

参数名	描述
iotDevice	: 要获取的设备
upgradeId	: 指定升级 ID

返回值

错误码，详见 ErrCode。

getMcuVersionInfo()

int com.agora.iotsdk20.IDeviceMgr.getMcuVersionInfo

(

IotDevice

iotDevice

)

获取设备古版本信息属性，触发 onGetMcuVerInfoDone 回调。

参数

参数名	描述
iotDevice	: 要获取固件的设备

返回值

错误码，详见 ErrCode。

getStateMachine()

int com.agora.iotsdk20.IDeviceMgr.getStateMachine

(

)

获取当前设备管理状态机。

返回值

设备管理状态机。

queryAllDevices()

int com.agora.iotsdk20.IDeviceMgr.queryAllDevices

(

)

查询当前用户名下所有设备。

成功查询到设备后，SDK 会触发 onAllDevicesQueryDone 回调。

返回值

错误码，详见 ErrCode。

queryAllPropertyDesc()

int com.agora.iotsdk20.IDeviceMgr.queryAllPropertyDesc	(	final String	deviceID,
		final String	productNumber
	)

查询所有属性描述符。

成功查询所有属性描述符后，SDK 会触发 onQueryAllPropertyDescDone 回调。 该方法支持通过 deviceID 或 productNumber 查询，选择其中一个参数查询时，另一个参数需要设置为 null。 不要同时填入 deviceID 和 productNumber 参数，否则该方法只会通过 deviceID 进行查询。

参数

参数名	描述
deviceID	设备 ID。
productNumber	产品唯一标识。

返回值

• 0: 方法调用成功。
• <0: 方法调用失败。

queryInSharedDevList()

int com.agora.iotsdk20.IDeviceMgr.queryInSharedDevList

(

)

查询来自其他账号分享的设备列表。

成功查询后，SDK 会触发 onQueryInSharedDevList 回调。

返回值

错误码，详见 ErrCode。

queryOutSharerList()

int com.agora.iotsdk20.IDeviceMgr.queryOutSharerList

(

final String

devcieID

)

查询单个设备分享出去的账号列表。

成功查询后，SDK 会触发 onQueryOutSharerListDone 回调。

参数

参数名	描述
devcieID	设备 ID。

返回值

错误码，详见 ErrCode。

queryProductList()

int com.agora.iotsdk20.IDeviceMgr.queryProductList

(

final ProductQueryParam

queryParam

)

获取产品列表。

成功获取后，SDK 会触发 onQueryProductDone 回调。

参数

参数名	描述
queryParam	产品查询参数，详见 ProductQueryParam。

返回值

错误码，详见 ErrCode。

querySharableDevList()

int com.agora.iotsdk20.IDeviceMgr.querySharableDevList

(

)

查询可分享的设备列表。

成功查询后，SDK 会触发 onQuerySharableDevListDone 回调。

返回值

错误码，详见 ErrCode。

queryShareMsgById()

int com.agora.iotsdk20.IDeviceMgr.queryShareMsgById

(

long

messageId

)

查询单个分享消息详情。

成功查询后，SDK 会触发 onQueryShareMsgDetailDone 回调。

参数

参数名	描述
messageId	要查询的分享消息 ID。

返回值

错误码，详见 ErrCode。

queryShareMsgByPage()

int com.agora.iotsdk20.IDeviceMgr.queryShareMsgByPage	(	int	pageNumber,
		int	pageSize,
		int	auditStatus
	)

分页查询设备分享消息。

成功查询后，SDK 会触发 onQueryShareMsgPageDone 回调。

参数

参数名	描述
pageNumber	要查询的页号，-1 表示不设置该参数。
pageSize	每页列表最大数量，-1 表示不设置该参数。
auditStatus	查询状态： 0：查询所有消息 1：查询已处理消息 2：查询未处理消息

返回值

错误码，详见 ErrCode。

registerListener()

int com.agora.iotsdk20.IDeviceMgr.registerListener

(

IDeviceMgr.ICallback

callback

)

注册回调接口。

参数

参数名	描述
callback	回调接口，详见 ICallback。

返回值

错误码，详见 ErrCode。

removeDevice()

int com.agora.iotsdk20.IDeviceMgr.removeDevice

(

IotDevice

removingDev

)

移除设备。

成功移除设备后，SDK 会触发 onDeviceRemoveDone 回调。

参数

参数名	描述
removingDev	要移除的设备信息，详见 IotDevice。

返回值

错误码，详见 ErrCode。

renameDevice()

int com.agora.iotsdk20.IDeviceMgr.renameDevice	(	IotDevice	iotDevice,
		String	newName
	)

重命名设备。

成功重命名设备后，SDK 会触发 onDeviceRenameDone 回调。

参数

参数名	描述
iotDevice	要重命名的设备信息，详见 IotDevice。
newName	新的名字。

返回值

错误码，详见 ErrCode。

setDeviceProperty()

int com.agora.iotsdk20.IDeviceMgr.setDeviceProperty	(	IotDevice	iotDevice,
		Map< String, Object >	properties
	)

设置设备属性。

成功设置后，SDK 会触发 onSetPropertyDone 回调。

参数

参数名	描述
iotDevice	要设置属性的设备，详见 IotDevice。
properties	要设置的属性列表。

返回值

错误码，详见 ErrCode。

shareDevice()

int com.agora.iotsdk20.IDeviceMgr.shareDevice	(	final IotDevice	iotDevice,
		final String	sharingAccount,
		int	permission,
		boolean	needPeerAgree
	)

分享设备给其他人。

该方法需要有对方接受。成功分享后，SDK 会触发 onShareDeviceDone 回调。

参数

参数名	描述
iotDevice	将要分享出去的设备，详见 IotDevice。
sharingAccount	分享的目标账号。
permission	分享的权限： 2: 可以传导分享 3: 不能传导分享
needPeerAgree	分享是否需要对端同意： true: 是 false: 否，即强制分享

返回值

错误码，详见 ErrCode。

unregisterListener()

int com.agora.iotsdk20.IDeviceMgr.unregisterListener

(

IDeviceMgr.ICallback

callback

)

注销回调接口。

参数

参数名	描述
callback	回调接口，详见 ICallback。

返回值

错误码，详见 ErrCode。

upgradeMcuVersion()

int com.agora.iotsdk20.IDeviceMgr.upgradeMcuVersion	(	IotDevice	iotDevice,
		long	upgradeId,
		int	decide
	)

升级设备固件版本，触发 onUpgradeMcuVerDone 回调。

参数

参数名	描述
iotDevice	: 要获取固件的设备
upgradeId	: 指定升级Id
decide	: 1不升级(忽略本次升级); 2升级(确定升级); 0无效的决定

返回值

错误码，详见 ErrCode。

类成员变量说明

static

DEVMGR_STATE_IDLE

final int com.agora.iotsdk20.IDeviceMgr.DEVMGR_STATE_IDLE = 0x0000

0x0000: 当前无设备操作。