https://github.com/netcookies/gewe-notify
Gewe-Notify 是一个基于 Home Assistant HACS 的插件，允许用户通过 Home Assistant 系统调用 Gewechat 后端 API 的发送微信。
https://github.com/netcookies/gewe-notify
docker home-assistant homeassistant homeassistant-integration wechat
Last synced: 10 months ago
JSON representation
Gewe-Notify 是一个基于 Home Assistant HACS 的插件，允许用户通过 Home Assistant 系统调用 Gewechat 后端 API 的发送微信。
- Host: GitHub
- URL: https://github.com/netcookies/gewe-notify
- Owner: netcookies
- License: mit
- Created: 2024-12-17T10:18:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-09T06:00:23.000Z (over 1 year ago)
- Last Synced: 2025-07-27T01:36:42.920Z (11 months ago)
- Topics: docker, home-assistant, homeassistant, homeassistant-integration, wechat
- Language: Python
- Homepage:
- Size: 276 KB
- Stars: 17
- Watchers: 1
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Gewe-Notify
Gewe-Notify 是一个基于 Home Assistant HACS 的插件，允许用户通过 **Home Assistant** 系统调用 **Gewechat** 后端 API 的发送微信。
## 功能特点
- 支持通过 Home Assistant 发送微信
- 支持 **Action --> Notify** 动作
- 支持 **微信在线状态实体**,可用于自动化检测微信是否在线
- 轻量、易于安装和配置
- 适用于使用 **Home Assistant** 和 **Gewechat** 的用户
## 安装
### 先决条件
- 确保你已安装 [Home Assistant](https://www.home-assistant.io/) 并已配置好 HACS（Home Assistant Community Store）。
- 本插件依赖 **Gewechat** 后端 API，请参阅 [Gewechat 部署文档](https://github.com/Devo919/Gewechat) 进行配置。
- **Gewechat** 是通过模拟一台iPad设备, 而微信只支持一台iPad登录,所以....
### 插图
1. 添加集成或重新配置时支持扫码登录
2. 搭配卡片使用搜索userName(wxid)
3. 调用 notify 发送微信
# TL;DR
### 安装插件
1. 打开 Home Assistant 系统并进入 HACS。
2. 搜索 **Gewe-Notify** 插件，并点击 **安装**。
3. 安装完成后，重启 Home Assistant 系统。
### 配置 Gewechat 后端
Gewe-Notify 插件需要配合 **Gewechat** 后端 API 使用。请按照以下步骤部署和配置 **Gewechat** 后端：
1. 根据 [Gewechat 配置指南](https://github.com/Devo919/Gewechat) 完成后端部署。
2. docker 稳定运行后访问`http://{docker_ip}:2531`，看到 **欢迎使用gewe后台管理框架** 就搞定了。
## 使用方法
1. 在 Home Assistant 中，进入插件设置页面，找到 **Gewe-Notify** 插件。
2. 配置 Gewechat API 的地址。ex:
```
# 假设你的容器 ip是192.168.0.2
http://192.168.0.2:2531
```
3. 首次运行请执行 **Action --> gewe_notify.fetch_contacts**, 可搭配`https://github.com/netcookies/gewe-notify-card`卡片查找target值
4. 在 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。 |
### 支持的实体、动作和其他功能
1. `sensor.gewe_notify_online_status` 显示微信在线状态，**True** 为在线，**False**为离线。
2. `action: gewe_notify.get_qrcode` 可手动调用获取登录的二维码，日志会打印当前二维码的url地址和uuid。**注意：获取二维码会退出当前账号**。
3. `action: gewe_notify.login` 在手机上执行完扫描二维码后调用，需要传入payload参数：uuid、img_url，这两个参数可以从上个action获取。
```
action: gewe_notify.login
data:
uuid: abcdefghijklmn
img_url: /local/gewe_qr_code.jpg?v=1234
```
### 在AppleWatch或其他设备上执行重新登录
1. 执行**http_post**调用`action: gewe_notify.get_qrcode`，ex：`http://your_ha_server_ip:port/api/services/gewe_notify/get_qrcode?return_response`
2. 从步骤1获取返回值uuid、img_url作为**post**或action参数，调用`action: gewe_notify.login`, ex: `http://your_ha_server_ip:port/api/services/gewe_notify/login`
3. ios 可以直接导入这个shortcuts `https://www.icloud.com/shortcuts/ed3f146607c0474693f29f32dd7fcd08`
## 贡献指南
欢迎大家为 **Gewe-Notify** 插件贡献代码！如果你希望参与开发，请遵循以下步骤：
1. Fork 本仓库。
2. 创建一个新的分支（`git checkout -b feature-branch`）。
3. 提交你的修改（`git commit -am 'Add new feature'`）。
4. 将更改推送到你的分支（`git push origin feature-branch`）。
5. 创建一个 Pull Request。
## 许可证
本项目使用 **MIT 许可证** - 详细信息请参见 [LICENSE](LICENSE) 文件。
## 感谢
- [Devo919/Gewechat](https://github.com/Devo919/Gewechat) 提供了后端 API。
- 感谢所有为 Gewe-Notify 和 Gewechat 项目做出贡献的开发者。
## 联系方式
如果你有任何问题或建议，欢迎提出 issue 或联系项目维护者。
---
### 说明
1. **项目描述**：介绍 **Gewe-Notify** 插件的功能，并指出它与 **Gewechat** 后端 API 的依赖关系。
2. **安装方法**：提供插件的安装方法以及 Gewechat 后端 API 的部署指南。
3. **使用方法**：详细说明如何配置和使用插件。
4. **配置**：介绍插件的配置项以及需要设置的 Gewechat API 信息。
5. **贡献指南**：如何为插件贡献代码。
6. **感谢**：特别感谢 **Gewechat** 提供的后端 API。