【开源学习】ThingsBoard -- 基本设置与使用

丝 · 2024-10-13 05:58:18

更新日记：

20240119 版本
- 新增资产管理与资产设置使用的内容；
20240203 版本
- 新增版本控制的设置和使用；
- 新增装备设置-装备设置创建-装备预设置内容介绍以及设置方法；
- 新增实体视图的设置和使用；

租户及客户管理

ThingsBoard 平台摆设完成并启动之后，将自动创建三个账户，分别为体系管理员、租户管理员以及用户。使用对应账号登陆体系可实行差别的操作，默认账号及密码如下：

System Administrator: sysadmin@thingsboard.org / sysadmin
Tenant Administrator: tenant@thingsboard.org / tenant
Customer User: customer@thingsboard.org / customer

复制代码

租户及租户账号管理

租户管理

租户创建

使用体系管理员账号（System Administrator）登陆体系，进入租户菜单，页面展示当前体系所有的租户信息。点击页面右上角“+”号进行新租户的创建。

点击“+”后弹出租户的新增页面，填写对应的数据后点击“添加”即可完成租户的创建。

租户修改

添加完成后，点击租户名称，在右侧弹出的详情页当中进入编辑模式即可对租户的信息进行修改。

信息修改完成后，点击右上角的对号即可保存更改，点击叉号取消更改。

租户删除

在租户菜单的展示列表中，点击对应租户数据行末的垃圾桶图标即可对租户进行删除操作。

租户账号管理

租户账号创建

在租户菜单的展示列表中，点击对应租户行末的圆形图标可以对租户的账号进行创建。

创建完成后，将直接以该账号登录体系。
租户账号修改

点击要修改的账号名，右侧弹出账号的详情信息，点击对应图标进入编辑模式即可对账号信息进行修改。

租户账号删除

点击要删除的账号末尾的垃圾桶图标，进行租户账号的删除操作。

客户及客户账号管理

客户管理

客户创建

使用上一节中创建的租户管理员账号登录体系，点击客户菜单，点击右上角“+”弹出创建对话框，填写信息进行客户的创建。

客户修改

客户的修改与租户修改类似，按照下图进行操作即可。

客户删除

删除操作与租户删除一致。

客户用户管理

客户用户创建

客户用户账号的创建与租户账号创建类似，操作步骤如下。

客户用户修改

客户用户修改与租户账号修改类似，按如下步骤操作即可。

客户用户删除

客户用户删除操作如下所示。

装备管理

本小节叙述如安在体系中进行装备的创建以及管理，同时叙述数据上传到装备的操作（MQTT协议为例）。
创建装备

装备按照下述步骤进行创建。起首在页面上点击相应按钮弹出装备创建对话框。

装备创建的第一步必要填写装备的详细信息，此处只必要填写装备名称即可，进入下一步。

装备创建第二步可以进行装备凭据信息的设置，勾选“添加凭据”后，可以选择对应的凭据类型，并手动输入或点击输入框末尾的按钮自动生成相应的令牌值。此处的凭据用于装备数据上传。

此处不设置（默认为”Access token“类型，体系自动生成令牌值），直接进入下一步。

装备创建第三步可以将装备分配给客户，供客户账号对其进行维护，此处非必选。

末了点击添加完成装备新增的操作。
装备修改

装备基础信息修改

可以按照下述步骤对装备的基础信息进行修改，包罗装备名称、装备设置、标签、分配固件、分配软件、是否网关、说明等信息。

装备用户分配

装备创建时如果没有分配给用户，或者想要修改分配的用户，可以按照下述操作进行修改。
如果装备已经被分配给了用户，可以通过装备信息末尾处的图标进行取消分配，也可以通过装备详情信息中的取消分配客户按钮取消分配。

未分配客户时，可以通过分配客户按钮或装备详情信息中的分配给客户按钮，将装备分配给客户进行管理。

装备凭据管理

创建装备时，如果没有进行装备凭据的设置，或者想要对设置的凭据进行修改，可以通过装备信息末尾处的管理凭据图标重新进行设置，也可以通过装备详情页面中的管理凭据按钮。

装备删除

可以通过以下操尴尬刁难装备进行删除。

装备数据上传

在默认的装备设置当中，支持基本 MQTT、HTTP 和 CoAP 传输协议，此处使用 MQTT 协议进行数据上传的设置演示。
起首按照下述操作获取装备的访问令牌。

获取令牌值后，对我们的 MQTT 客户端进行设置，设置中主要关注以下几个要点：

设置客户端broker为tcp://ip_address:1883；
MQTT 客户端设置的username应该为上述步骤中复制的装备令牌；
topic应该指定为v1/devices/me/telemetry；

按上述条件进行设置后，发送以下消息进行测试，该消息中发送了两个属性，分别为温度和湿度：

"{"temperature": 32, "humidity": 10}"

复制代码

在装备详情页面检察装备数据的上报环境，查询到相应的数据且数据值正确，证明装备端到 ThingsBoard 平台端的通路正常：

资产管理

本小节叙述如安在体系中进行资产的创建以及管理，资产与装备是类似的概念，装备实在是资产中单独抽象出来的一个分类。
创建资产

资产的创建步骤与装备创建类似，但要简单许多，详细操作过程如下。

资产修改

资产基础信息修改

资产的基础信息可以通过下述操作进行修改。

资产用户分配

通过下列操作可以将资产分配给指定的用户。

若要取消某一资产的分配，可以按照下述操作进行取消，随后可以按照之前的操作重新选择分配客户。

资产删除

按照下列步骤可以实现资产的删除操作。

仪表盘管理

仪表盘主要用于以各种图表的情势，展示装备上传的原始数据、数据趋势，以及报警信息等。
仪表盘创建

仪表盘可以通过以下步骤进行创建。

仪表盘设置

新创建的仪表盘是没有任何内容的，详细的仪表盘展示内容与结构必要租户管理员进行设置，设置完成后授权分发给指定的用户即可。
仪表盘关联装备

下述步骤将实现通过仪表盘来展示装备上传的及时数据。

在仪表盘部件编辑页面中，起首必要将要展示的装备关联到仪表盘当中，才华在部件中进行展示设置，如下操作所示。

此处我们将之前创建的装备关联到仪表盘当中，可以为装备取一个别名用于在仪表盘中展示。筛选器类型选择单个实体用于导入单个装备，类型选择装备，在右侧下拉框中选择我们要关联进来的装备名称，如下操作所示。

至此我们将创建的装备关联到了新建的仪表盘当中，接下来我们必要选取符合的展示部件用于对装备数据的展示。
仪表盘部件设置

此处我们添加一个卡片组件用于观察装备上报的及时数据，并添加一个图表组件来观察装备上报数据的趋势。

接下来进行部件展示内容的设置（在设置要展示的装备的属性时，可以选择多个）。

采用同样的方法，再添加一个图表组件。

此时两个部件已经添加完毕，点击对应的组件，按住左键拖动鼠标可以调解组件的位置。鼠标放在组件边沿时，按住鼠标左键拖动鼠标可以调解组件的大小。将组件的大小和位置调解符合后，点击右下角的对勾图标保存更改。

此时可以再次发送数据检察图标数据的展示。

若想要修改仪表盘部件的数据源，再次点击右下角图标进入编辑模式，选择要修改的部件进行设置的修改即可。

若要对部件进行删除，则在部件修改模式中，点击对应部件右上角的叉号，对部件进行删除操作，然后保存仪表盘更改内容即可。

仪表盘用户分配

设置完成的仪表盘必要分配给相应的用户，对应用户才华获得仪表盘的访问权。上述设置完成的仪表盘没有分配给任何的用户，此时使用用户账号登录体系，进入仪表盘菜单，可以看到没有可检察的仪表盘。
按下述操作，将上一节中设置的仪表盘分配给之前创建的客户。

完成分配后，再次登录对应客户下的用户账号，即可在仪表盘菜单中对该仪表盘进行检察（只有检察权限，无法进行修改）。
若想要取消仪表盘的分配，按照上述仪表盘分配的操作，在第四步选择要分配的用户是，设置为空，然后更新即可。
仪表盘修改

参照下列步骤可以对仪表盘的基本信息进行修改。

仪表盘删除

按照下述步骤可以实现对仪表盘的删除操作。

规则链库

体系提供了规则链库供开发人员自行设置消息的变换、过滤、计算与传输。
规则链创建

体系提供了一个默认的根规则链支持用户使用，此处不在根规则链上进行改动，而是将根规则链导出后重新导入，然后在新导入的规则链中进行修改和设置。
起首按照下列步骤导出根规则链，点击导出后体系将自动实行下载，导出的文件为 json 格式。

将导出的设置重新导入体系。点击导入后，体系将直接跳转到新导入的规则链的设置页面，直接点击右下角的应用更改按钮即可。重新退出到规则链库菜单即可看到新导入的规则链库设置。

规则链修改

按照下述步骤可以对规则链的基本信息进行修改。可以为上一小节中导入的规则链进行重命名。

规则链删除

按照下列操作可以对新创建的规则链进行删除操作（注：体系提供的默认根规则链不可删除）。

规则链设置

若必要对规则链进行设置，则必要按照下列操作进入规则链的设置页面。

体系提供了 6 类规则节点供开发人员进行设置，分别为筛选器、属性集、变革、动作、外部、流。若必要设置某一规则节点，则点击鼠标将对应节点拖入右侧编辑页面并进行设置，然后添加即可。

接下来对差别类中大概比较常用的、对数据进行操作的规则节点的设置进行解说，由于之前装备的创建中应用了默认的装备设置（后续会解说），默认装备设置中使用规则链为根链Root Rule Chain，因此下面的演示均为在 Root Rule Chain 中进行的设置。
筛选器

check fidles presence

该规则节点用于验证消息体或者消息的元数据中的某些属性是否存在，并根据验证结果对消息进行分发。该节点的设置内容有：

名称：必填项，表明该节点的名称；
Message field names：消息体中需验证的属性名，该消息即装备自动发送的消息内容。此处可以设置多个，每个属性输入完后按“回车”键入；
Metadata field names：消息元数据中必要验证的属性名，元数据为体系附带的数据，在默认设置的环境下一样平常有deviceType、deviceName以及ts三个元数据属性。此处可以设置多个，每个属性输入完后按“回车”键入；
Check that all specified fields are present：选择框，勾选后，在进行上述的属性验证时，各验证条件以“与”进行连接；不勾选时，在进行上述的属性验证时，各验证条件以“或”进行连接；
说明：非必填项，附加说明；

根据判断结果，该规则节点的出口有true和false两种。
简单使用示例如下：

script

该规则节点允许开发人员以编程的方式实现数据的过滤，即实现自界说的过滤规则对消息进行分发。该节点的设置内容有：

名称：必填项，表明该节点的名称；
function Filter：代码（通过代码自界说过滤规则），函数入参包罗 msg（消息）、metadata（元数据）、msgType（上一节点推送的消息类型），返回值应为布尔值；
说明：非必填项，附加说明；

根据代码逻辑，该规则节点的出口有true和false两种。
简单使用示例如下：

return msg.temperature > 20;

复制代码

switch

该规则节点允许开发人员以编程的方式实现数据的分组过滤，即实现自界说的分发规则对数据进行分发。该节点的设置内容有：

名称：必填项，表明该节点的名称；
function Switch：代码（通过代码自界说分组规则），函数入参包罗 msg（消息）、metadata（元数据）、msgType（上一节点推送的消息类型），返回值应为字符串数组，指示要分发的路径；
说明：非必填项，附加说明；

根据代码逻辑，该规则节点的出口由编码人员进行界说，见示例。
简单使用示例如下：

if (msg.temperature > 25) {
return ['High temperature'];
} else if (msg.temperature < 18) {
return ['Low temperature'];
} else {
return ['Normal temperature'];
}

复制代码

上述代码中界说了三个出口，分别为High temperature、Low temperature以及Normal temperature。因此，在连接下一个节点时，我们要按照我们界说的出口路径自界说连接，如下图所示。输入完成后按“回车”创建一个链接标签，然后点击添加即可。

属性集

calculate delta

该规则节点用于计算本条消息中的数据与上一条消息中的对应数据的差值，并根据计算结果对消息内容进行完善和分发。该节点的设置内容有：

名称：必填项，表明该节点的名称；
Input value Key：必填项，要进行增量计算的属性名称；
Output value Key：必填项，计算所得的增量值添加到消息体中的属性名称；
Decimals：增量计算的精度；
Use cache for latest value：选择项，使用内存存储上一数据的值，默认勾选；
Tell Failure if delta is negative：选择项，若增量值为负数，则认为消息处理失败，默认勾选；
Add period between messages：选择项，在消息体中添加与上一条消息的时间差值，默认不勾选。勾选后需填写 Period value key，作为计算所得的时间差值添加到消息体中的属性名称；
说明：非必填项，附加说明；

根据运行结果，该规则节点的出口有Success、Failure以及Other三种：

Success ：增量计算乐成的数据出口；
Failure：消息处理失败的数据出口，若勾选 Tell Failure if delta is negative，则计算增量为负的数据从该出口输出；
Other：消息中缺失要实行增量计算的属性值的数据出口；

简单使用示例如下：

customer attributes

该规则节点用于将设置给用户的一些属性添加到消息的元数据当中，并根据处理结果分发数据。该节点的设置内容有：

名称：必填项，表明该节点的名称；
Latest telemetry：选择项，选择后将根据设置的密钥获取客户远程上报的最新属性值，取消勾选则查询装备所属客户的服务端属性，默认取消勾选；
Source telemetry key：输入项，要添加到消息元数据的客户属性名称；
Target attribute：输入项，要添加到消息元数据中的属性名，与 Source telemetry key 承兑出现，可添加多对属性；
说明：非必填项，附加说明；

根据运行结果，该规则节点的出口有Success、Failure两种。当未给装备设置所属的客户时，数据从Failure出口输出。
此处涉及到用户属性的设置，可以按照如下操作进行设置。

该规则节点简单的使用示例如下：

customer details

该规则节点用于将设置给用户的一些详情信息添加到消息当中，并根据处理结果分发数据。该节点的设置内容有：

名称：必填项，表明该节点的名称；
Select entity details：多选项，选择要添加到消息当中的客户的详细信息（在创建客户时进行设置的信息，包罗国家、都会、地点、邮箱等…），添加的信息的属性名格式为customer_详细内容名；
Add selected details to message metadata：选择项，若勾选则将相应的信息添加到元数据当中向下游节点传递；若不勾选则将相应的信息添加到数据当中向下游节点传递。默认不勾选；
说明：非必填项，附加说明；

根据运行结果，该规则节点的出口有Success、Failure两种。当未给装备设置所属的客户时，数据从Failure出口输出。
简单的使用示例如下：

tenant attributes

该规则节点用于将设置给租户的一些属性添加到消息的元数据当中，并根据处理结果分发数据。该节点的设置内容与 customer attributes 规则节点的设置完全相同，此处不再赘述。
此处涉及到租户属性的设置，可以按照如下操作进行设置。

简单的使用示例如下：

tenant details

该规则节点用于将设置给租户的一些详情信息添加到消息当中，并根据处理结果分发数据。该节点的设置内容与 customer details 规则节点的设置完全相同，此处不再赘述。
简单的使用示例如下：

fetch device credentials

该节点用于将装备的密钥以及 token 类型添加到消息中向下游节点传递。节点设置内容包罗：

名称：必填项，表明该节点的名称；
Fetch credentials to metadata：选择项，勾选后将装备密钥信息添加至元数据，否则添加到消息数据，默认勾选；
说明：非必填项，附加说明；