本帖最后由 netcookies 于 2025-1-2 13:35 编辑
Gewe-Notify
Gewe-Notify 是一个基于 Home Assistant HACS 的插件,允许用户通过 Home Assistant 系统 Gewechat 后端 API 的接收和发送微信通知。
功能特点
- 支持通过 Home Assistant 的notify action 发送微信
- 可以自定义通知设置,选择不同的通知类型
- 轻量、易于安装和配置
- 适用于使用 Home Assistant 和 Gewechat 的用户
1. 添加集成或重新配置时可以扫码登录
2. 搭配卡片使用搜送username(wxid)
3. 调用notify发送微信消息
4. 微信成功接收
安装
先决条件
安装插件
- 打开 Home Assistant 系统并进入 HACS。
- 搜索 Gewe-Notify 插件,并点击 安装。
- 安装完成后,重启 Home Assistant 系统。
配置 Gewechat 后端
Gewe-Notify 插件需要配合 Gewechat 后端 API 使用。请按照以下步骤部署和配置 Gewechat 后端:
- 根据 Gewechat 配置指南 完成后端部署。懒得看的可以直接 docker 部署就好了,什么都不用配置 。推荐大家还是关心下大佬去 start 下
docker run -itd -p 2531:2531 -p 2532:2532 --privileged=true --name=gewe registry.cn-hangzhou.aliyuncs.com/gewe/gewe:latest
- docker 稳定运行后访问
http://{docker_ip}:2531 ,看到 欢迎使用gewe后台管理框架。 就搞定了。
TL;DR
使用方法
- 在 Home Assistant 中,进入插件设置页面,找到 Gewe-Notify 插件。
- 配置 Gewechat API 的地址,ex:
# 假设你的容器 ip是192.168.0.2
http://192.168.0.2:2531
- 首次运行请执行 Action --> gewe.fetch_contacts, 可搭配
https://github.com/netcookies/gewe-notify-card 卡片查找target值
- 在 Action 中找到notify.gewe_notify填入target, 默认消息类型是文本(text), message是必填字段, 但仅在文本类型时有效, 其他类型时请随意填写, 不为空就行, 支持的消息类型见下表。ex:
action: notify.gewe_notify
data:
data:
message_type: image
img_url: https://dummyimage.com/300x300
target: someones_wxid
message: 这是一个图片消息(图片类型没有message 参数所以无效,但message 是Notify 组件的必填项)
支持的消息类型及所需参数
消息类型 |
所需参数 |
描述 |
text |
message ,ats (可选) |
发送文本消息。ats 是一个可选参数,用于提及用户。 |
file |
file_url ,file_name |
发送文件消息。 |
image |
img_url |
发送图片消息。 |
voice |
voice_url ,voice_duration |
发送语音消息。voice_duration 是语音消息的时长,单位为秒。 |
video |
video_url ,video_duration ,thumb_url |
发送视频消息。video_duration 是视频的时长,thumb_url 是视频的缩略图 URL。 |
link |
link_url ,title ,desc ,thumb_url |
发送链接消息。title 是链接的标题,desc 是描述,thumb_url 是缩略图 URL。 |
贡献指南
欢迎大家为 Gewe-Notify 插件贡献代码!如果你希望参与开发,请遵循以下步骤:
- Fork 本仓库。
- 创建一个新的分支(
git checkout -b feature-branch )。
- 提交你的修改(
git commit -am 'Add new feature' )。
- 将更改推送到你的分支(
git push origin feature-branch )。
- 创建一个 Pull Request。
许可证
本项目使用 MIT 许可证 - 详细信息请参见 LICENSE 文件。
感谢
联系方式
如果你有任何问题或建议,欢迎提出 issue 或联系项目维护者。
说明
- 项目描述:介绍 Gewe-Notify 插件的功能,并指出它与 Gewechat 后端 API 的依赖关系。
- 安装方法:提供插件的安装方法以及 Gewechat 后端 API 的部署指南。
- 使用方法:详细说明如何配置和使用插件。
- 配置:介绍插件的配置项以及需要设置的 Gewechat API 信息。
- 贡献指南:如何为插件贡献代码。
- 感谢:特别感谢 Gewechat 提供的后端 API。
|