- 打印
将Node-RED与Tulip API一起使用
如果你在自己的设备上使用Node-RED,并希望向Tulip API发送数据,Tulip为API端点提供Node-RED节点。
这些节点预装在支持Node-RED的Tulip设备上,但如果你正在运行自己的Node-RED实例,你仍然可以通过安装Node-RED库中的@tulip/node-red-tulip-api
包来安装这些节点。
在这篇文章中,你将学习如何...
- 在你的Node-RED安装中添加Tulip API节点
- 使用Tulip Machine Attribute API向Tulip Machine发送数据
- 使用Tulip Tables API节点来读取、写入和配置Tulip Tables。
先决条件。
在Tulip的边缘MC上运行Node-RED?请看此入门指南
安装
1.将@tulip/node-red-tulip-api
加入你的Node-RED调色板中
打开你的Node-RED编辑器,导航到菜单→管理调色板
点击安装标签,然后搜索@tulip/node-red-tulip-api
注意:你也可以通过命令行安装该软件包。导航到你的Node-RED用户目录(即cd ~/.node-red/
)并运行npm install @tulip/node-red-tulip-api
2.检查安装是否成功
如果安装成功,tulip-machine-attribute
和tulip-tables
节点将在调色板(左侧边栏)的Tulip类别下可见。
使用郁金香机器属性节点
先决条件:你已经阅读了如何使用机器属性API,有一个配置了属性:写
权限的API机器人,并且有一个你希望发送数据的特定机器属性。
1.1.将一个郁金香机器属性节点拖放到你的流程中。
注意:在右侧边栏,选择 帮助 选项卡,查看关于如何使用该节点的文档。
2.2.配置该节点以匹配目标机器属性。
我们将使用下面的机器属性作为一个例子。注意,机器数据源是Tulip API。
郁金香机器的整数机器属性为 "示例郁金香API机器"。
双击节点以打开其编辑器,然后配置节点以匹配这个机器属性。例如,你可以按以下方式配置你的节点。
郁金香机器属性节点的配置。
在郁金香API认证节点配置如下(填入你的认证凭证)。
API机器人的郁金香API认证配置。
3.测试发送数据。
创建其余的流程来发送数据到机器属性的端点。
一个简单的测试流程可能是将值0发送到一个整数端点。将机器属性节点的输入连接到一个配置为msg.payload=0
的Inject节点(如下图所示)。将输出连接到打印完整味精
的调试节点。
点击Deploy来部署流程。当你点击Inject节点时,你应该看到一个状态代码为204的调试信息。
测试流程,发送整数值0到一个整数机器属性。
数据也应该显示在你的Tulip实例的机器属性下。
使用Tulip Tables API节点
先决条件:你已经阅读了《如何使用表API》,有一个配置了tables:read
和tables:write
权限的API机器人,并且有一个你希望发送数据的特定表。
1.1.拖放一个Tulip Tables节点到你的流程中。
注意:在右边的侧边栏,选择 帮助 选项卡,查看关于如何使用该节点的文档。
2.2.为一个特定的郁金香表API查询配置节点。
首先双击该节点以打开其编辑器。设置郁金香API认证配置节点,以匹配具有tables:read
和/或tables:write
权限的API机器人的细节(取决于表查询是读还是写操作)。
表API机器人配置
将查询类型设置为你想执行的查询。然后,其余的查询选项将根据该类型出现。
在这个例子中,我们将选择列出记录,以列出状态字段为 "REVIEW "的ID为9YHHckKcFTXHQpXEu
的表中记录。
表API节点配置
从表API节点的 "过滤器 "字段展开的JSON。
3.测试发送数据。
创建其余的流程,将数据发送到Tables API端点。
一个测试流程的例子是将一个空的Inject节点连接到Tables API节点的输入,以触发发送API请求。你也可以添加一个调试节点,打印msg.payload
来查看解析后的响应。
请看下面的结果,当配置好的Tables API请求被发送到以下表格时,在your-subdomain.tulip.co/tables/9YHHckKcFTXHQpXEu
。请注意,响应会返回两个表项,状态字段设置为REVIEW。
要查询的表有几条记录。包括一个状态字段,我们可以通过它来过滤。
发送 "列表记录 "表API请求到郁金香表的流程,以及响应的有效载荷。
进一步阅读
@tulip/node-red-tulip-api
软件包README- 如何使用表API
- 如何使用机器属性的API