# hongyan-skill

**Repository Path**: ai-king/hongyan-skill

## Basic Information

- **Project Name**: hongyan-skill
- **Description**: 鸿雁通信技能-让Agent通信更简单
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-23
- **Last Updated**: 2026-03-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 鸿雁通信技能 (Hongyan Skill)

**版本**: 3.0.0  
**状态**: ✅ 生产就绪  
**作者**: 澜宝  
**特性**: 🔓 独立通用协议，不依赖任何平台（飞书/微信等）

---

## 🎯 功能

让 OpenClaw Agent 具备实时通信能力：

- ✅ 私聊通信（一对一）
- ✅ 群组通信（一对多）
- ✅ 端到端加密
- ✅ 离线消息队列
- ✅ REST API 集成
- ✅ 简单机器人模板

---

## 📦 安装

### 自动安装

```bash
openclaw skills install hongyan-skill
```

### 手动安装

```bash
cd C:\Users\Administrator\.openclaw\workspace\skills
python hongyan-skill\install.py
```

---

## 🚀 快速开始

### 1. 在 Agent 中启用

编辑 `openclaw.json`:

```json
{
  "skills": {
    "entries": {
      "hongyan-skill": {
        "enabled": true
      }
    }
  },
  "hongyan": {
    "ws_url": "ws://127.0.0.1:8765",
    "agent_id": "my_agent",
    "enable_encryption": false
  }
}
```

### 2. 启动 WebSocket 服务器

```bash
cd C:\Users\Administrator\.openclaw\workspace\skills\hongyan\v3
python lanbao_server_v4.py
```

### 3. 在 Agent 中使用

```python
from hongyan.v3 import HongyanSDK

# 创建通信客户端
sdk = HongyanSDK(
    agent_id="my_agent",
    ws_url="ws://127.0.0.1:8765"
)

# 连接
await sdk.connect()

# 发送消息
await sdk.send(
    to="other_agent",
    content="你好！"
)

# 监听消息
@sdk.on_message
async def handle(message):
    print(f"收到：{message.payload.content}")
    await sdk.reply(message, "收到！")

await sdk.listen()
```

---

## 🔧 集成到现有 Agent

### 方法 1：使用技能类

```python
from hongyan_skill import HongyanAgentSkill

# 创建技能
skill = HongyanAgentSkill(
    agent=self,  # 当前 Agent 实例
    config={
        "ws_url": "ws://127.0.0.1:8765",
        "agent_id": "my_agent"
    }
)

# 初始化
await skill.initialize()

# 发送消息
await skill.send_message(to="xxx", content="...")
```

### 方法 2：直接使用 SDK

```python
from hongyan.v3 import HongyanSDK

sdk = HongyanSDK(agent_id="my_agent")
await sdk.connect()
# ... 使用 SDK
```

---

## 📋 配置选项

| 选项 | 默认值 | 说明 |
|------|--------|------|
| `ws_url` | `ws://127.0.0.1:8765` | WebSocket 服务器地址 |
| `agent_id` | `my_agent` | Agent ID |
| `enable_encryption` | `false` | 是否启用加密 |
| `enable_groups` | `true` | 是否启用群组 |
| `enable_offline` | `true` | 是否启用离线消息 |

---

## 📖 使用示例

### 私聊

```python
# 发送
await sdk.send(to="alice", content="你好")

# 接收并回复
@sdk.on_message
async def handle(message):
    await sdk.reply(message, "收到！")
```

### 群聊

```python
# 创建群组
group = await sdk.create_group(
    name="项目组",
    members=["alice", "bob"]
)

# 群发
await sdk.broadcast(group.group_id, "开会了")
```

### 加密通信

```python
sdk = HongyanSDK(
    agent_id="secure_agent",
    enable_encryption=True
)

await sdk.send(
    to="alice",
    content="机密内容",
    encrypt=True
)
```

---

## 🐛 故障排除

### 无法连接服务器

```bash
# 检查服务器是否运行
netstat -ano | findstr ":8765"

# 启动服务器
python skills/hongyan/v3/lanbao_server_v4.py
```

### 消息发送失败

```python
# 检查对方是否在线
try:
    success = await sdk.send(to="xxx", content="...")
    if not success:
        print("对方不在线")
except Exception as e:
    print(f"错误：{e}")
```

---

## 📞 获取帮助

- **快速开始**: `skills/hongyan/v3/QUICKSTART.md`
- **完整文档**: `skills/hongyan/v3/README.md`
- **示例代码**: `skills/hongyan/v3/examples/`

---

**让 Agent 通信更简单！** 🚀