产品定价 立即试用
IoT网关
文档 > 物联网网关功能 > 服务RPC方法
入门
安装
目录

服务RPC方法

本指南说明如何在ThingsBoard IoT Gateway中使用RPC API。

本教程需要:
1.本地安装的ThingsBoard平台实例(若为新用户请参考安装文档)。 2.已安装配置 ThingsBoard IoT Gateway。

步骤1:创建用于ThingsBoard IoT Gateway RPC API的仪表板

要使用调试终端,需从控制部件包添加RPC调试终端部件。
按以下步骤操作:

-打开仪表板标签页;

-添加新仪表板;

-打开已创建的仪表板,点击右下角的铅笔按钮进入编辑模式,然后点击”添加新部件“按钮;

-选择部件包- “Control widgets“;

-向下滚动并选择RPC debug terminal部件;

-我们尚未为部件指定实体类型,因此需要新建一个

-填写必填字段并保存实体。Gateway -即我们的网关设备;

-应用所有更改;

-连接后的部件如下所示(连接自动建立)。
现在您可以使用调试终端向网关发送RPC请求。

步骤2:网关RPC方法

要向网关发送RPC请求,应使用Control widgets包中的RPC Debug Terminal部件。
ThingsBoard IoT Gateway默认提供多个可从Web UI调用的RPC方法。
开箱即用的方法列表将在后续版本中持续扩展。

gateway_ping RPC方法

gateway_ping RPC方法用于检查与网关的连接状态及RPC处理状态。 所有带”gateway_“前缀的命令将被解释为发送给网关通用服务的命令,而非发送给连接器或设备的RPC请求。 命令:

1
gateway_ping

响应为:

1
2
3
4
{
  "code": 200,
  "resp": "pong"
}

网关RPC ping方法

gateway_devices RPC方法

gateway_devices RPC方法用于列出通过网关连接的设备及其所使用的连接器类型信息。 此方法在”resp”中返回包含键值对参数的对象,其中: 键 — 设备名称 值 — 连接器标识

命令:

1
gateway_devices

返回对象示例:

1
2
3
4
5
6
{
  "code": 200,
  "resp": {
    "Device Number One": "OPC-UA Connector"
  }
}

网关RPC设备方法

gateway_restart RPC方法

gateway_restart RPC方法用于调度重启操作,例如bash gateway_restart 60将在60秒后重启网关服务。 此方法以秒为计时单位。

注意:响应将在任务添加到网关调度器后返回。

命令:

1
gateway_restart 60

响应为:

1
{"success": true}

网关RPC重启方法

gateway_reboot RPC方法

gateway_reboot RPC方法用于调度网关设备(硬件)的重启操作,例如bash gateway_reboot 60将在一分钟后重启网关设备。 请注意:此方法仅在以Python模块方式(而非守护进程方式)启动网关服务且运行网关的用户具有重启权限时可用。 命令:

1
gateway_reboot 60

响应为:

1
{"success": true}

注意:响应将在任务添加到网关调度器后返回。

网关RPC重启设备方法

remove_provisioned_credentials RPC方法

gateway_remove_provisioned_credentials RPC方法用于从配置文件夹中删除设备凭证。 如果网关实例启用了设备预配置功能,网关将在下次启动时自动重新预配置。

命令:

1
gateway_remove_provisioned_credentials

响应为:

1
{"code": 200, "resp": "Provisioned credentials file removed successfully."}

下一步

探索ThingsBoard主要功能相关指南: