Add CAN Protocol Guide to Interfacing Wiki#254
Open
farnazalamahmed99-cmu wants to merge 7 commits into
Open
Conversation
Added comprehensive documentation on Controller Area Network (CAN) protocol, including setup, usage, and debugging in robotics systems.
Controller Area Network (CAN)
nevalsar
force-pushed
the
master
branch
2 times, most recently
from
4f6c490 to
ca3abce
Compare
nevalsar
changed the title
nevalsar
requested changes
May 9, 2026
Collaborator
nevalsar
left a comment
nevalsar
left a comment
There was a problem hiding this comment.
Thanks for the contribution. Before this can be merged, please rebase this branch onto the latest master so the new PR validation workflow (recently added on master) runs on this PR.
I also found two required fixes:
-
Fix page filename/format
- The new file is currently
wiki/interfacing/CAN(no.mdextension, non-kebab-case). - Please rename it to a markdown page in repo style, for example
wiki/interfacing/controller-area-network-can.md, then update any internal references accordingly.
- The new file is currently
-
Discoverability integration
- Add the new page to
_data/navigation.ymlunder the Interfacing section. - Add the new page to
wiki/interfacing/index.mdwith a short summary.
- Add the new page to
Optional but recommended:
- Add a short “when to use this guide” paragraph near the top and trim/condense the references section to keep long-term maintenance manageable.
After rebasing and the above fixes, I can re-review quickly.
Collaborator
|
In addition to the above requested fixes,
|
Added guidance on when to use the CAN protocol for robotic systems, emphasizing its reliability and real-time performance. Removed an example use case to streamline the document.
Author
|
I have renamed the file, updated the navigation, and merged the redundant sections as requested. Ready for a re-review |
Author
|
I have made the required changes. Kindly check, Apologies for the delay
…On Mon, 11 May 2026 at 22:37, p-amyjiang ***@***.***> wrote:
*p-amyjiang* left a comment
(RoboticsKnowledgebase/roboticsknowledgebase.github.io#254)
<#254 (comment)>
In addition to the above requested fixes,
- Merge CAN Physical Layer and Hardware Requirements, and Example Use
in a Robotics System and Usage in Robotics Systems - the content in these
pairs of sections is somewhat redundant and repetitive.
—
Reply to this email directly, view it on GitHub
<#254 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BVQF36NYMSLECARFLDQA3NT42KE75AVCNFSM6AAAAACYLUYMT6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHM2DIMRWHA4DGOBWGM>
.
You are receiving this because you authored the thread.Message ID:
<RoboticsKnowledgebase/roboticsknowledgebase.github.
***@***.***>
|
nevalsar
requested changes
May 19, 2026
Collaborator
There was a problem hiding this comment.
I found three blocker issues still that need attention:
- Missing section-index discoverability entry:
wiki/interfacing/index.md(section list around lines 10-31) does not include this new CAN page. Please add it with a short summary.
Other issues - see below code suggestions.
@p-amyjiang for another pass on content review.
nevalsar
requested changes
May 19, 2026
| - title: micro-ROS for ROS2 on Microcontrollers | ||
| url: /wiki/interfacing/microros-for-ros2-on-microcontrollers/ | ||
| - title: ROS 1 - ROS 2 Bridge | ||
| url: /wiki/interfacing/ros1_ros2_bridge/ |
Collaborator
There was a problem hiding this comment.
This path should stay kebab-case and match the existing page slug.
Suggested change
| url: /wiki/interfacing/ros1_ros2_bridge/ | |
| url: /wiki/interfacing/ros1-ros2-bridge/ |
| url: /wiki/interfacing/buffer-issues/ | ||
| - title: "CAN Protocol" | ||
| url: /wiki/interfacing/controller-area-network-can/ | ||
| url: /wiki/interfacing/ros1-ros2-bridge/ |
Collaborator
There was a problem hiding this comment.
This extra url line is currently nested under the CAN Protocol item and breaks the one-title/one-url structure. Please remove it.
Suggested change
| url: /wiki/interfacing/ros1-ros2-bridge/ |
|
|
||
| ## See Also | ||
|
|
||
| - [ROS2 QoS](/wiki/networking/ros2-qos/) |
Collaborator
There was a problem hiding this comment.
This link target is broken in current validation output. Please point to an existing page.
Suggested change
| - [ROS2 QoS](/wiki/networking/ros2-qos/) | |
| - [ROS2 QoS](/wiki/interfacing/ros1-ros2-bridge/) |
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
3 participants
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.
Added a new wiki article on Controller Area Network (CAN) covering:
This article is intended to provide a practical introduction to CAN communication in robotics.