# 协议规范文档

本目录包含 JRSoft Subway WebSocket 协议的核心规范文档。

## 📚 文档列表

### [协议规范](./specification.md)
完整的 WebSocket 协议定义，包括：
- 消息格式和类型
- 客户端类型定义
- 命令系统设计
- 错误处理机制
- 协议版本管理

### [消息类型详解](./message-types.md)
所有消息类型的详细说明：
- register - 客户端注册
- command - 命令请求
- command_response - 命令响应
- progress_update - 进度更新
- program - 节目上传
- program_response - 节目响应
- heartbeat - 心跳保活
- error - 错误消息

### [设计理念](./design-rationale.md)
协议设计的核心理念和决策：
- 为什么选择 WebSocket
- 消息格式设计考量
- 命令系统架构决策
- 扩展性和兼容性设计

## 🚀 快速开始

如果您是第一次接触本协议，建议按以下顺序阅读：

1. 先阅读[设计理念](./design-rationale.md)了解协议的设计思想
2. 然后查看[协议规范](./specification.md)掌握整体结构
3. 最后深入[消息类型详解](./message-types.md)了解具体实现

## 🔗 相关文档

- [命令系统文档](../02-commands/) - 了解不同类型的命令
- [架构文档](../03-architecture/) - 了解系统架构和消息流
- [集成指南](../04-integration/) - 如何集成协议到您的系统