使用机器属性 API

Prev Next

如何使用机器属性 API

使用来自 Node-RED、Python 或其他服务的数据创建一个 Tulip 机器。

NOTE

Advanced Article - assumes previous experience with REST APIs.Click here to view our Machines API documentation.

总结

通过 Machine Attributes API,您可以使用/attributes/report端点,经由 RESTful API 将数据发送至机器的特定属性。这为从 Node-RED、Python 或其他语言及服务与 Tulip 集成提供了多种灵活选项。

配置 Machine API

Feature rename

Prior to r383, Service Accounts were called "API Tokens".

注意:如果您已配置Tulip 表 API,则可使用该 API 密钥和密钥密文。

  1. 导航至**“设置” > “Tulip API”**
  2. 点击屏幕右上角的**“创建服务账户”**
  3. 为服务账户命名,并将其作用域设置为**attributes:report**:

  1. 此时将弹出一个包含您的API 密钥、密钥密文和 认证头信息的模态窗口。请务必保存这些信息,因为后续将无法再次查看!

设置新机器

设置好机器 API 后,您的实例上将出现一个新的机器数据源。要查看此数据源,请点击**“生产车间**”>“机器”,然后导航至**“机器数据源”:**

您需要创建一台与该数据源关联的新机器。要创建新机器,请导航至**“机器库**”,然后点击**“创建机器”。**

将出现以下模态窗口:

  1. 设备名称(必填):为您的设备命名
  2. 机器数据源(必填):选择Tulip API
  3. 站点(可选)
  4. 类型(必填):如果没有可用类型,请先创建一个类型;在本示例中,创建的类型名为default

现在设备已创建,您需要添加一个属性。点击屏幕右上角的“编辑”。然后点击屏幕右上角的**“+”**按钮:

由于尚未创建任何机器属性,请点击蓝色的“机器类型”(此处为“默认”)。

这将带您进入与该机器关联的机器类型页面。点击屏幕右上角的*“编辑”*按钮。

接着点击左下角“机器属性”旁边的“+”按钮。

现在点击右下角的***“+ 创建机器属性”***

在此示例中,我们将创建一个类型为**“整数**”的计数器属性。

属性创建完成后,在“机器属性”列表中点击该计数器属性,然后点击右上角的“保存”

返回您的机器页面。

现在机器属性已创建完成,您可以将其添加到机器中。点击右上角的*“编辑”按钮。然后点击右上角的*“+”按钮,并选择您刚刚创建的“计数器”**属性:

请点击右上角的**“保存”**。

您的 Tulip 实例现已配置好 Machine API、一台机器和一个机器属性——现在您可以从任何地方向 Tulip 机器发送数据了!

在此处,您可以查看*“计数器*”属性的attributeId和machineID。点击图标即可复制这些信息,这些信息将用于 HTTP 请求的请求体中。

要完成此操作,您需要熟悉 REST API。有关如何使用/attributes/report端点的完整文档(包括查询参数和请求正文格式),请访问your-company.tulip.co/apidocs或点击Tulip API页面上的链接...

……文档中还有一节专门介绍机器监控

进一步阅读

如果您想进一步探索该 API,并了解如何将其与 Edge MC 和 Node-RED 结合使用,请阅读这篇文章!