ekuiper-new/etc/mqtt_source.json

{
	"about": {
		"trial": false,
		"author": {
			"name": "EMQ",
			"email": "contact@emqx.io",
			"company": "EMQ Technologies Co., Ltd",
			"website": "https://www.emqx.io"
		},
		"helpUrl": {
			"en_US": "https://github.com/lf-edge/ekuiper/blob/master/docs/en_US/rules/sources/mqtt.md",
			"zh_CN": "https://github.com/lf-edge/ekuiper/blob/master/docs/zh_CN/rules/sources/mqtt.md"
		},
		"description": {
			"en_US": "eKuiper provides built-in support for MQTT source stream, which can subscribe the message from MQTT broker and feed into the eKuiper processing pipeline.",
			"zh_CN": "eKuiper 为 MQTT 源流提供了内置支持，流可以订阅来自 MQTT 代理的消息并输入 eKuiper 处理管道。"
		}
	},
	"libs": [],
	"properties": {
		"default": [{
			"name": "connectionSelector",
			"default": "",
			"optional": true,
			"control": "select",
			"type": "string",
			"values": [],
			"hint": {
				"en_US": "specify the source to reuse the connection defined in connection configuration.",
				"zh_CN": "此数据源复用 connection 中定义的连接"
			},
			"label": {
				"en_US": "Connection selector",
				"zh_CN": "复用连接信息"
			}
		}, {
			"name": "server",
			"default": "tcp://127.0.0.1:1883",
			"optional": true,
			"connection_related": true,
			"control": "text",
			"type": "string",
			"hint": {
				"en_US": "The server for MQTT message broker.",
				"zh_CN": "MQTT 消息代理的服务器。"
			},
			"label": {
				"en_US": "Server Address",
				"zh_CN": "服务器地址"
			}
		}, {
			"name": "username",
			"default": "",
			"optional": true,
			"connection_related": true,
			"control": "text",
			"type": "string",
			"hint": {
				"en_US": "The username for MQTT connection.",
				"zh_CN": "MQTT 连接用户名。"
			},
			"label": {
				"en_US": "Username",
				"zh_CN": "用户名"
			}
		}, {
			"name": "password",
			"default": "",
			"optional": true,
			"connection_related": true,
			"control": "text",
			"type": "string",
			"hint": {
				"en_US": "The password for MQTT connection.",
				"zh_CN": "MQTT 连接密码。"
			},
			"label": {
				"en_US": "Password",
				"zh_CN": "密码"
			}
		}, {
			"name": "protocolVersion",
			"default": "3.1.1",
			"optional": true,
			"connection_related": true,
			"control": "select",
			"values": [
				"3.1",
				"3.1.1"
			],
			"type": "string",
			"hint": {
				"en_US": "MQTT protocol version. 3.1 (also refer as MQTT 3) or 3.1.1 (also refer as MQTT 4). If not specified, the default value is 3.1.",
				"zh_CN": "MQTT 协议版本。3.1 (也被称为 MQTT 3) 或者 3.1.1 (也被称为 MQTT 4)。 如果未指定，缺省值为 3.1。 "
			},
			"label": {
				"en_US": "MQTT Protocol Version",
				"zh_CN": "MQTT 协议版本"
			}
		}, {
			"name": "clientid",
			"default": "",
			"optional": true,
			"connection_related": true,
			"control": "text",
			"type": "string",
			"hint": {
				"en_US": "The client id for MQTT connection. If not specified, an uuid will be used.",
				"zh_CN": "MQTT 连接的客户端 ID。 如果未指定，将使用一个 uuid。"
			},
			"label": {
				"en_US": "MQTT Client ID",
				"zh_CN": "客户端 ID"
			}
		}, {
			"name": "qos",
			"default": 1,
			"optional": true,
			"control": "select",
			"type": "int",
			"values": [0, 1, 2],
			"hint": {
				"en_US": "The default subscription QoS level.",
				"zh_CN": "默认订阅 QoS 级别"
			},
			"label": {
				"en_US": "Qos level",
				"zh_CN": "QoS 级别"
			}
		}, {
			"name": "certificationPath",
			"default": "",
			"optional": true,
			"connection_related": true,
			"control": "text",
			"type": "string",
			"hint": {
				"en_US": "The location of certification path. It can be an absolute path, or a relative path.",
				"zh_CN": "证书路径。可以为绝对路径，也可以为相对路径。如果指定的是相对路径，那么父目录为执行 server 命令的路径。"
			},
			"label": {
				"en_US": "Certification path",
				"zh_CN": "证书路径"
			}
		}, {
			"name": "privateKeyPath",
			"default": "",
			"optional": true,
			"connection_related": true,
			"control": "text",
			"type": "string",
			"hint": {
				"en_US": "The location of private key path. It can be an absolute path, or a relative path. ",
				"zh_CN": "私钥路径。可以为绝对路径，也可以为相对路径。"
			},
			"label": {
				"en_US": "Private key path",
				"zh_CN": "私钥路径"
			}
		}, {
			"name": "rootCaPath",
			"default": "",
			"optional": true,
			"connection_related": true,
			"control": "text",
			"type": "string",
			"hint": {
				"en_US": "The location of root ca path. It can be an absolute path, or a relative path. ",
				"zh_CN": "根证书路径，用以验证服务器证书。可以为绝对路径，也可以为相对路径。"
			},
			"label": {
				"en_US": "Root CA path",
				"zh_CN": "根证书路径"
			}
		}, {
			"name": "insecureSkipVerify",
			"default": false,
			"optional": true,
			"connection_related": true,
			"control": "radio",
			"type": "bool",
			"hint": {
				"en_US": "Control if to skip the certification verification. If it is set to true, then skip certification verification; Otherwise, verify the certification.",
				"zh_CN": "控制是否跳过证书认证。如果被设置为 true，那么跳过证书认证；否则进行证书验证。"
			},
			"label": {
				"en_US": "Skip Certification verification",
				"zh_CN": "跳过证书验证"
			}
		}, {
			"name": "kubeedgeVersion",
			"default": "",
			"optional": true,
			"control": "text",
			"type": "string",
			"hint": {
				"en_US": "Kubeedge version number. Different version numbers correspond to different file contents.",
				"zh_CN": "Kubeedge 版本号，不同的版本号对应的文件内容不同"
			},
			"label": {
				"en_US": "Kubeedge version",
				"zh_CN": "Kubeedge 版本号"
			}
		}, {
			"name": "kubeedgeModelFile",
			"default": "",
			"optional": true,
			"control": "text",
			"type": "string",
			"hint": {
				"en_US": "The name of KubeEdge template file. The file is located in the specified etc/sources folder.",
				"zh_CN": "KubeEdge 模版文件名，文件指定放在 etc/sources 文件夹中"
			},
			"label": {
				"en_US": "KubeEdge model file",
				"zh_CN": "KubeEdge 模型文件"
			}
		}]
	},
	"outputs": [
		{
			"label": {
				"en_US": "Output",
				"zh_CN": "输出"
			},
			"value": "signal"
		}
	],
	"node": {
		"category": "source",
		"icon": "iconPath",
		"label": {
			"en_US": "MQTT",
			"zh_CN": "MQTT"
		}
	}
}