> For the complete documentation index, see [llms.txt](https://doc.yuncitys.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.yuncitys.com/shu-ju-chu-li-gui-ze-yin-qing/gui-ze-lian-gong-neng-jie-dian/filter.md).

# Filter

Filter节点用于邮件筛选和路由。

* 检查节点关系
* 检查存在字段
* 消息类型过滤
* 消息类型切换
* 发起者类型
* 发起者类型转换
* 脚本
* 交换
* GPS地理围栏过滤器
  * 从消息元数据中获取边界信息
  * 从节点配置中获取周边信息

### **检查节点关系**

![](/files/-MK496JpIB8_xUWr2PM9)

根据类型和方向检查从所选实体到消息发起者的关系。

![](/files/-MK49AAaF-qcdCskIikF)

如果存在关系-消息通过**True**链发送否则使用**False**链。

**注意:** 从Thingsboard 2.3版开始规则节点可以通过禁用规则节点配置进行根据方向和关系类型检查与特定实体或任何实体的关系是否存在：

![](/files/-MK49ZdiezOQLi2-NeKM)

如果禁用复选框并且存在任何关系-消息通过**True**链发送否则使用**False**链。

### **1. 检查存在字段**

![](/files/-MK49aQxdAaq87BVDxcL)

检查入站的消息数据和元数据中所选键的是否存在。

如果选中复选框**Check that all selected keys are present**表示消息数据和元数据中的所有键是否存在，如果为**True**则通过此链发送消息否则使用**False**链。

如果未选中此复选框并且消息的数据或元数据中至少有一个键存在通过**True**链发送消息否则使用**False**链。

### **2. 消息类型过滤**

![](/files/-MK49fqKjJRQXCKSYTYE)

管理员为入站消息定义了一组允许的消息类型。

系统中有预定义的消息类型；例如：**Post Attributes**、**Post Telemetry**、**RPC Request**等。

![](/files/-MK49kV9HNc52LPrsX6r)

如果入站消息类型-通过**True**链发送消息否则使用**False**链。

### **3. 消息类型切换**

![](/files/-MK49lphJPHX-qmfkgOm)

根据消息类型路由入站的消息。

如果入站的消息具有已知的消息类型则将其发送到相应的链否则将消息发送到**Other**链。

如果使用自定义消息类型则可以通过消**Message Type Switch Node**的**Other**链将这些消息路由到配置了所需路由逻辑的**Switch Node**或**Message Type Filter Node**。

### **4. 发起者类型**

![](/files/-MK49o72-Ze08HRzuuAe)

管理员配置发起者实体类型过滤入站消息。

![](/files/-MK49q4m7cKkKrItJnLJ)

如果是预期的入站发起者类型-通过**True**链发送消息否则使用**False**链。

### **发起者类型转换**

![](/files/-MK49uDs99ScRiXvYXdG)

通过发起者实体类型路由入站消息。

### **脚本**

![](/files/-MK4A-42PltvhWoMph9Q)

使用配置的JavaScript条件传入的消息。

JavaScript函数接收3个输入参数：

· **msg** - 消息payload

· **metadata** - 消息metadata

· **msgType** - 消息类型

脚本应返回布尔值如果为**True**-通过**True**链发送消息否则使用**False**链。

![](/files/-MK4A0w_UFxQMt_3XcG5)

消息payload可以通过**msg**变量访问。例如**msg.temperature < 10;**\
可以通过**metadata**变量访问消息。例如**metadata.customerName === 'John';**\
可以通过**msgType**变量访问。例如**msgType === 'POST\_TELEMETRY\_REQUEST'**

完整脚本示例:

&#x20;&#x20;

```
if(msgType === 'POST_TELEMETRY_REQUEST') {
    if(metadata.deviceType === 'vehicle') {
        return msg.humidity > 50;
    } else if(metadata.deviceType === 'controller') {
        return msg.temperature > 20 && msg.humidity > 60;
    }
}

return false;
```

### **交换**

![](/files/-MK4AI3FSlGUXTvrDYQY)

根据入站消息路由到一个或多个输出链节点执行已配置的JavaScript函数。

JavaScript函数接收3个输入参数：

· **msg** - 消息payload

· **metadata** - 消息metadata

· **msgType** - 消息类型

该脚本应返回一个将消息路由到的**下一关系名称的数组**。

如果返回的数组为空-消息将不会路由到任何节点并被丢弃。

![](/files/-MK4AJpvW6D4bVkv_e6B)

消息payload可以通过**msg**变量访问。例如**msg.temperature < 10;**\
可以通过**metadata**变量访问消息。例如**metadata.customerName === 'John';**\
可以通过**msgType**变量访问。例如**msgType === 'POST\_TELEMETRY\_REQUEST'**

完整脚本示例:

```
if (msgType === 'POST_TELEMETRY_REQUEST') {
    if (msg.temperature < 18) {
        return ['Low Temperature Telemetry'];
    } else {
        return ['Normal Temperature Telemetry'];
    }
} else if (msgType === 'POST_ATTRIBUTES_REQUEST') {
    if (msg.currentState === 'IDLE') {
        return ['Idle State', 'Update State Attribute'];
    } else if (msg.currentState === 'RUNNING') {
        return ['Running State', 'Update State Attribute'];
    } else {
        return ['Unknown State'];
    }
}
return [];
```

为了指定自定义关系名称，应选择自定义类型。这将允许输入自定义关系名称。定制关系名称不区分大小写。

![](/files/-MK4AQrBHb1uUI28NZSW)

### &#x20;**GPS地理围栏过滤器**

![](/files/-MK4AUxQZ_hqBlKgI4wH)

通过参数过滤消息的传入基于GPS的从数据或元数据中提取纬度和经度并检查它们是否在配置的边界（地理围栏）内。

![](/files/-MK4AWKydoo-Mqfedfar)

默认情况下规则节点从消息元数据中获取外围信息如果未**Fetch perimeter information from message metadata**则应配置其他信息。

**从消息元数据中获取边界信息**

根据边界类型有两种区域定义选项:

·&#x20;

多边形（Polygon)

·&#x20;

入站消息的元数据必须包含具有名称**范围**和以下数据结构的密钥：

·&#x20;

**\[\[lat1,lon1],\[lat2,lon2], ... ,\[latN,lonN]]**

· 圈（Circle）

```
"centerLatitude": "value1", "centerLongitude": "value2", "range": "value3"

All values for these keys are in double-precision floating-point data type.

The "rangeUnit" key requires specific value from a list of METER, KILOMETER, FOOT, MILE, NAUTICAL_MILE (capital letters obligatory).
```

### **从节点配置中获取周边信息**

根据边界类型有两种区域定义选项：

· 多边形（Polygon)

![](/files/-MK4AfAiT1-vlO-FchFY)

· 圈（Circle）

![](/files/-MK4AhYkc3KNzZhXSjC9)

如果配置的纬度和经度在通过**True**链发送的配置的周界消息内部则使用**False**链。

在以下情况下将使用**故障**链：

传入消息在数据或元数据中没有配置的纬度或经度键。 缺少周界定义；