Dev202503 #9
Merged
Dev202503 #9
Conversation
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
…ld work simultaneously
You can use CSM Tools to debugging your application. You can find the entry from labview project toolbar, CSM palette, quick drop and Right-Click menu of CSM loops.
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for the reusable TCP communication layer by introducing a dedicated protocol section in both the English and Chinese README files and adding new protocol definition documents.
- Updated the English README with a new “## Protocol” section detailing the TCP packet format.
- Updated the Chinese README with a new “## 通讯协议” section and a link to the detailed protocol documents.
- Added new protocol definition files for both English (v0) and Chinese (v0 and v1).
Reviewed Changes
Copilot reviewed 24 out of 30 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Added Protocol section with TCP packet format details. |
| README(zh-cn).md | Added 通讯协议 section; note an inconsistency in header order. |
| .doc/Protocol.v1.(zh-cn).md | New advanced protocol definition with additional fields. |
| .doc/Protocol.v0.(zh-cn).md | New Chinese version of the original protocol definition. |
| .doc/Protocol.v0.(en).md | New English version of the original protocol definition. |
Files not reviewed (6)
- .doc/CSM-TCP-Router.drawio: Language not supported
- CSM-TCP-Router.vipb: Language not supported
- src/CSM-TCP-Router.lvcsm: Language not supported
- src/CSM-TCP-Router.lvproj: Language not supported
- src/Server/_support/Module/CSM-TCP-Router.lvlib: Language not supported
- src/csm-app.ini: Language not supported
Comments suppressed due to low confidence (1)
.doc/Protocol.v1.(zh-cn).md:28
- [nitpick] Consider using a consistent bit literal format (i.e. '0b00010000') for FLAG_CRC to match the style used for FLAG_TEXT and FLAG_BIN.
FLAG_CRC = 0B00010000 # 存在CRC校验（置1时需解析CRC校验）
| CSM-TCP-Router 中 TCP 数据包格式定义如下： | ||
|
|
||
| ``` | ||
| | 数据长度(4B) | 版本(1B) | FLAG1(1B) | FLAG2(1B) | TYPE(1B) | 文本数据 | |
There was a problem hiding this comment.
The header field order in the Chinese README is inconsistent with the protocol definition in .doc/Protocol.v0.(zh-cn).md. Consider reordering the fields to match the established order.
Suggested change
| | 数据长度(4B) | 版本(1B) | FLAG1(1B) | FLAG2(1B) | TYPE(1B) | 文本数据 | | |
| | 数据长度(4B) | 版本(1B) | TYPE(1B) | FLAG1(1B) | FLAG2(1B) | 文本数据 | |
Copilot uses AI. Check for mistakes.
github-project-automation
bot
moved this from Linked to PR
to Done
in Communicable State Machine(CSM)
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.
No description provided.