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

Update hardware_communication.md with Stenograph USB format info from… #1702

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ThaiWood
Copy link

… plugin docs

Summary of changes

This is the explanation of the protocol extracted from the stenograph_usb plugin, just with Mira replaced with writer since it applies to all of them.

Somewhere I have the doc where this was originally copied from and a draft of some extra abilities (e.g. packet IDs to do different things), but I figure this is a good start.

@mkrnr
Copy link
Contributor

mkrnr commented Feb 24, 2025

Thank you so much @ThaiWood for the contribution!

I'm wondering, however, whether we want to include this info in the plover documentation since it's regarding logic of a plugin and not plover itself. To me it feels more natural to link to the plugin documentation instead.

@sammdot what are your thoughts on this?

@sammdot
Copy link
Member

sammdot commented Feb 24, 2025

Agree on this being included in the plugin documentation, at least for now. If we ever decide to bring this and other machine protocols into Plover's codebase then sure, but for right now I think keep it with the plugin.

@ThaiWood
Copy link
Author

I think I'm missing something here. Is the disucssion to move this section or the hardware communication doc? If the former, what would go under the USB-based Protocols section if not things like the packet format of a USB protocol?

@mkrnr
Copy link
Contributor

mkrnr commented Feb 27, 2025

Sorry for the confusion! We should only include USB protocols in this documentation that are implemented in this repo which is not the case for stenograph.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants