矩阵


这种集成使您可以将消息发送到矩阵室,并对矩阵室中的消息做出反应。当触发一个配置的命令之一时,通过发射事件来完成对命令的反应。

目前,家庭助理中的以下设备类型支持:必威是什么

配置

#示例Configuration.yaml条目矩阵家庭服务器https://matrix.org用户名@my_matrix_user:matrix.org“密码SuperSecurePassword房间-#hasstest:matrix.org“命令-单词my_command姓名my_command

配置变量

用户名 细绳 必需的

矩阵用户名应该用来登录。必威是什么笔记:您必须在此处指定完整的矩阵ID,包括HomeServer域,例如‘@my_matrix_bot:matrix.org’。还请注意,“@”字符在YAML中具有特殊的含义,因此必须始终以报价给出。

密码 细绳 必需的

矩阵帐户的密码。

家庭服务器 细绳 必需的

您的家庭服务器的完整URL。必威体育存款如果使用默认matrix.org homeserver,这是'https://matrix.org’。

verify_ssl 细绳 ((可选的,默认:正确

验证HomeServers证书。

房间 细绳 ((可选的,默认:空

机器人应加入并侦听命令的房间列表(请参见下文)。您可以限制某个命令适用于人均的房间列表(请参见下文),但您仍然必须列出所有房间here that commands should be received in. Rooms can be given either by their internal ID (e.g., ‘!cURbafjkfsMDVwdRDQ:matrix.org’) or any of their aliases (e.g., ‘#matrix:matrix.org’).

命令 地图 ((可选的,默认:空

机器人应该收听的命令列表。如果触发命令(通过其单词或者表达,请参见下文),触发您可以使用自动化处理的事件。每个命令都包含以下可能的配置选项:

单词 细绳 ((可选的

指定机器人应该听的单词。如果您在此处指定“ my_command”,则该机器人将对以“!my_command”开头的任何消息做出反应。

表达 细绳 ((可选的

指定机器人应收听的正则表达式(在Python Regexp语法中)。该机器人将对与正则表达式匹配的任何消息做出反应。

姓名 细绳 必需的

命令的名称。这将是当此命令触发时发射的事件的属性。

房间 细绳 ((可选的,默认:空

机器人应在此中收听此命令的房间列表。如果不给出此命令,房间使用主要配置中的列表。请注意,此列表中的每个房间也必须位于主要房间配置。

为了防止对命令做出反应时,您必须使用单独的帐户进行矩阵集成。

事件数据

如果触发了命令,matrix_command事件被解雇。该事件包含该命令的名称姓名场地。

如果命令是词命令,则数据字段包含命令的参数列表,即站在单词后面的所有内容,在空格上分裂。如果命令是表达式命令,则数据字段包含小组词典与消息匹配的正则表达式。

综合配置示例

此示例还使用矩阵通知平台

#矩阵组件矩阵家庭服务器https://matrix.org用户名@my_matrix_user:matrix.org“密码SuperSecurePassword房间-#hasstest:matrix.org“-#someothertest:matrix.org“命令-单词测试词姓名测试词房间-#someothertest:matrix.org“-表达我的姓名(?p <名称>。*)”姓名介绍通知-姓名matrix_notify平台矩阵default_room#hasstest:matrix.org“自动化-别名'反应!testword'扳机平台事件事件类型matrix_commandevent_data命令测试词行动服务notify.matrix_notify数据信息看起来喜欢!testword”-别名'反应一个介绍'扳机平台事件事件类型matrix_commandevent_data命令介绍行动服务notify.matrix_notify数据信息你好{{trigger.event.data.args ['name']}}”

此配置将:

  • 在房间里听“!testword”“ #someothertest:matrix.org”(和只要) 那里。如果遇到了这样的消息,它将以“ #hasstest:matrix.org”频道回答“看起来像您写的!testword”。
  • 在两个房间里聆听任何匹配的消息“我的名字是 ”并回答“你好 ”进入“ #hasstest:matrix.org”。

通知

矩阵平台允许您从家庭助理传达通知必威是什么矩阵房间。房间既可以是直接的,也可以是集体聊天。

要在安装中启用矩阵通知,您首先需要配置矩阵组件。然后,将以下内容添加到您的configuration.yaml文件:

#示例Configuration.yaml条目通知-姓名notifier_name平台矩阵default_roomROOM_ID_OR_ALIAS

配置变量

姓名 细绳 ((可选的,默认:通知

设置可选参数姓名允许创建多个通知器。通知者将绑定到服务notify.notifier_name

default_room 细绳 必需的

当不给出其他目标时,所有消息将发送到所有消息。

目标室必须重新处理,可以从房间设置对话框中获得房间ID。房间默认情况下具有形式的规范ID“!:homeserver.tld”,但也可以分配的别名“ #RoomName:homeserver.tld”。确保在房间ID或别名周围使用引号来逃避特殊字符(, 和)在yaml。根据各个房间的政策,可能需要邀请通知帐户进入房间。

要使用通知,请参阅自动化页面入门

图像中的图像

可以发送通知的图像。为此,在通知中添加路径列表数据

#图像通知的示例行动服务notify.matrix_notify数据信息测试图片”数据图片-/path/to/picture.jpg

如果您需要在通知中包含外部文件夹中的文件,则必须列出允许的源文件夹

configuration.yaml...乡亲allowlist_external_dirs-/TMP