Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a page that explains the basics of the Dynamixel communication-system. #305

Draft
wants to merge 16 commits into
base: main
Choose a base branch
from

Conversation

Claegtun
Copy link
Contributor

@Claegtun Claegtun commented May 8, 2024

Makes a page that explains some of the basics of the the Dynamixel communication-system, including some of the electrical theory and the protocol itself.

One of the motives for this was the fact that some students may not know much about differential signals, the 8N1 frame, half-duplexity, etc. some ofwhich are concepts that I had to teach myself when I began working on NUSense. For example, I have recently had to teach a new member how RS485 works and half-duplexity. For future generations, it might be nice to have a single place to which new team-members can go.

Another motive is that it might be good to document any Dynamixel idiosyncracities (that are not documented by Robotis).

Todo

  • Add information about the protocol, e.g. packet-structures.
  • Make the information on the electrical side more concise.

Preview

https://deploy-preview-305--nubook.netlify.app/system/hardware/dynamixel-protocol

@Claegtun Claegtun added documentation Improvements or additions to documentation WIP A work in progress, feedback welcome but things might change labels May 8, 2024
Copy link

netlify bot commented May 8, 2024

Deploy Preview for nubook ready!

Name Link
🔨 Latest commit a5afb5b
🔍 Latest deploy log https://app.netlify.com/sites/nubook/deploys/6653c287d7f61f0008e9db88
😎 Deploy Preview https://deploy-preview-305--nubook.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Claegtun
Copy link
Contributor Author

Claegtun commented May 8, 2024

I am not sure whether it should be under guides or system. It is not really a guide, but it is also not unique to the NUgus system.

@Claegtun
Copy link
Contributor Author

Claegtun commented May 8, 2024

Should it be split into two pages, one for the electrical side and another for the protocol?

@ysims
Copy link
Member

ysims commented May 8, 2024

Probably system. System is sort of describing things and guides is showing you how to do something.
I'd keep as one page.

@Claegtun Claegtun self-assigned this May 16, 2024
Copy link
Member

@ysims ysims left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

partial review

src/book/02-system/04-hardware/04-dynamixel-protocol.mdx Outdated Show resolved Hide resolved
src/book/02-system/04-hardware/04-dynamixel-protocol.mdx Outdated Show resolved Hide resolved
Comment on lines +17 to +21
The target-audience is somewhat broad and can be anywhere between

- a team-member who is experienced with the Dynamixel system but wants to cross-reference something,
- a new electrical, computer, or mechatronics engineering student who has had some experience with some of these concepts such as UART in ELEC2720 but may want to refresh some of the basics and needs to learn some new things such as RS485 and the Dynamixel protocol,
- and a computer-science student who has some experience with telecommunications such as Ethernet but may have no experience at all with UART and RS485.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd remove this part, particularly as you mention assumed knowledge next.

src/book/02-system/04-hardware/04-dynamixel-protocol.mdx Outdated Show resolved Hide resolved
src/book/02-system/04-hardware/04-dynamixel-protocol.mdx Outdated Show resolved Hide resolved
src/book/02-system/04-hardware/04-dynamixel-protocol.mdx Outdated Show resolved Hide resolved
src/book/02-system/04-hardware/04-dynamixel-protocol.mdx Outdated Show resolved Hide resolved
src/book/02-system/04-hardware/04-dynamixel-protocol.mdx Outdated Show resolved Hide resolved
src/book/02-system/04-hardware/04-dynamixel-protocol.mdx Outdated Show resolved Hide resolved
src/book/02-system/04-hardware/04-dynamixel-protocol.mdx Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation WIP A work in progress, feedback welcome but things might change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants