docs: sync EN/ZH protocol and README files; document info packet lifecycle events#24
Merged
nevstop merged 7 commits intoDev_2026Q1from Mar 16, 2026
Merged
Conversation
Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update Protocol.v0.(zh-cn).md content
完善 Protocol.v0.(zh-cn).md：添加 cmd-resp 握手机制说明与通信流程图
Mar 16, 2026
nevstop
reviewed
Mar 16, 2026
nevstop
reviewed
Mar 16, 2026
nevstop
reviewed
Mar 16, 2026
nevstop
reviewed
Mar 16, 2026
nevstop
requested changes
Mar 16, 2026
Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com>
nevstop
reviewed
Mar 16, 2026
nevstop
reviewed
Mar 16, 2026
nevstop
reviewed
Mar 16, 2026
nevstop
requested changes
Mar 16, 2026
Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the v0 Chinese protocol specification to document the cmd-resp handshake mechanism and to add/adjust Mermaid sequence diagrams describing sync/async/subscription communication flows.
Changes:
- Reassigns packet TYPE enum values and adds explicit
cmd-resptype documentation. - Adds a
cmd-respsection explaining handshake behavior (and notes about sync messages not using it). - Adds Mermaid sequence diagrams for sync, async, async-no-reply, and subscribe/unsubscribe flows (including
interrupt).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Contributor
|
@copilot apply changes based on the comments in this thread |
Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com>
Contributor
Author
已按评审意见应用（98de0c6）：
|
Closed
Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com>
Copilot
AI
changed the title
完善 Protocol.v0.(zh-cn).md：添加 cmd-resp 握手机制说明与通信流程图
docs: document info packet behavior on connect and disconnect
Mar 16, 2026
Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com>
Copilot
AI
changed the title
docs: document info packet behavior on connect and disconnect
docs: sync EN/ZH protocol and README files; document info packet lifecycle events
Mar 16, 2026
nevstop
approved these changes
Mar 16, 2026
nevstop
added a commit
that referenced
this pull request
Mar 28, 2026
* [add] #23 Export "Net Address" for bind server to network adapter. * [update] 更新数据包类型定义，添加指令响应和订阅中断广播返回数据包 * docs: sync EN/ZH protocol and README files; document info packet lifecycle events (#24) * Initial plan * 完善 Protocol.v0.(zh-cn).md: 添加 cmd-resp 握手说明和通信流程图 Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com> * 根据审查意见更新 Protocol.v0.(zh-cn).md：修正包类型值、同步流程和异步流程图 Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com> * 根据审查意见修正 cmd-resp 注释、同步流程说明及异步流程图逻辑 Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com> * 统一 error 包描述，修正异步无返回流程文字与图表一致性 Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com> * Add info packet documentation for connection/disconnection events Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com> * Sync EN/ZH protocol and README files for consistency Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com> * 25 and 26 bug multi client cannot receive msg concurrently (#28) * #25 Completed the issues fix. Co-Authored-By: NEVSTOP <8196752+nevstop@users.noreply.github.com> * #26 Back-up >> works on interrupt * #26 Completed the interrupt mode and new Example 6 for demo this feature * change after code review --------- Co-authored-by: NEVSTOP <8196752+nevstop@users.noreply.github.com> Co-authored-by: nevstop <nevstop@NEVSTOP-LAB> * Update CSM-TCP-Router.lvcsm 删除这个文件, 并 ignore Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Sync and improve README (en/zh-cn) content and language Agent-Logs-Url: https://github.com/NEVSTOP-LAB/CSM-TCP-Router-App/sessions/62cc62ad-c940-4e13-9a74-7c924ca9d168 Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com> --------- Co-authored-by: nevstop <nevstop@NEVSTOP-LAB> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: Kiven GiveUp <316979271@qq.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
infopacket type was undocumented regarding when the server emits it, and the Chinese/English versions of bothProtocol.v0andREADMEhad diverged — different packet type codes, missing types, and a wrong header field order in the Chinese README.Info packet documentation
Both
Protocol.v0.(en).mdandProtocol.v0.(zh-cn).mdnow document the two situations where the server sends aninfopacket:Good bye.Protocol.v0.(en).md — brought in sync with Chinese version
cmd-resp (0x03), renumberedresp → 0x04,async-resp → 0x05,status → 0x06, addedinterrupt (0x07)cmd-resp) section explaining the handshake acknowledgment semantics (distinct from business response data)-@,->,->|, and<register>/<unregister>README files
README.mdandREADME(zh-cn).md: packet type lists updated to matchProtocol.v0(samecmd-resp/interruptadditions and renumbering)README(zh-cn).md: fixed incorrect header field order —TYPEwas placed afterFLAG1/FLAG2instead of before them🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.