tiny-pilot / tinypilot

Use your Raspberry Pi as a browser-based KVM.
https://tinypilotkvm.com
MIT License
3.07k stars 259 forks source link

other Keyboard layouts for pasting? #1830

Closed DustyDiamond closed 2 months ago

DustyDiamond commented 4 months ago

Hi, nice work with tinypilot so far. I have the problem that I can't really change the keyboard layout/language on my target system. I can only choose between German or en-US/french/netherlands ( all with belgian periods -.- ) So naturally when trying to paste text it gets mingled a lot. Just typing with my host and target set to german works fine, but you can imagine typing 20+ char passwords with special characters is a hassle when you could paste them ;) So my question: Is it planned or in consideration to extend the paste feature with like a dropdown for other keyboard layouts? Or is there another way to get it to work (prefarably with german layout). I didn't get the chance to look at all the code but it seems tinypilot is interpreting "normal keystrokes" different from what the paste menu does. So maybe it would be sufficient to let the paste menu pretend that what is in the textbox got "typed by the user" since the normal typing in window is working perfectly fine with german layout on host and target. Alternatively maybe you could pull the "hardcoded" hid variables out and always go the route of a "defined language" like with en-US and en-GB, so the community could add other layouts for you, so you dont have the work ;) Greetings from Germany :)

cghague commented 4 months ago

Hi @DustyDiamond, thanks for your question about pasting text.

You are correct that the "Paste" functionality only works with the en-US and en-GB languages. This limitation is because TinyPilot needs to convert the plain text provided into a format that it can send over USB, and this can only be done by looking up each value. This requirement means only languages we have a lookup table for will fully work.

I see that you're a technical user. If you're comfortable working with code, you may be able to add support for your desired language by adding it to the text-to-hid lookup tables. Our contributing guidelines are a good starting point for developing with TinyPilot.

I hope this is helpful! Please let me know if you have any questions!

DustyDiamond commented 3 months ago

Ok so i made some changes in a local clone of the repo and tried to commit to a branch tied to this issue. But the Checks always fail. To be more precise check-all.py tries to execute ./dev-scripts/check-for-init-files which doesnt even exist in the repo, but ./dev-scripts/check-for-init-py-files does exist. So by fixing this in check-all.py it works until the next step. Then ./dev-scripts/check-python tries to execute the coverage command but fails with coverage: command not found but when I execute the pre-commit hook manually coverage runs, still with errors but it runs. ^^ (See picture below)

image

I can't really test the changes, beacause the dev-mode tinypilot wont really show me the pastet contents, but console shows me good hex-values in hid.write. And I can't test it on my Pi4B because I can't commit to a dev-branch to clone onto the pi. What would be the best way to move on now? I'm not new to coding but collaboration via git(hub/lab) is pretty new to me :D

cghague commented 3 months ago

Thanks for getting back to me so quickly! I've looked at your fork on GitHub, and the changes seem great! My only observation is that MODIFIER_RIGHT_ALT should function as MODIFIER_ALT_GR on a system with a suitable keyboard layout, so there's no need to define it manually.

Assuming you followed these instructions to set up your development environment, the coverage: command not found error most likely means you've not activated the Python venv before running the command. You can activate the Python venv by running . venv/bin/activate.

Regarding the check-all issue, I've looked, and this line does appear to be a mistake. The actual command appears on this line in check-python instead. I'll ask our developers to investigate.

DustyDiamond commented 3 months ago

Hi @cghague , I requested a PR which is adding the German locale Support for pasting. Best Regards

cghague commented 3 months ago

That's awesome, thanks @DustyDiamond!

You should only need the modified build files in your local environment. The only files that we'd need are likely to be:

Can you please push a new commit that leaves just those files? If all goes well, our continuous integration platform will successfully complete a test build, and I can share this with the team for a complete code review.

Thanks again!

DustyDiamond commented 3 months ago

Hi @cghague , I created a new PR with only the 3 files necessary. Best Regards

cghague commented 3 months ago

Thanks, @DustyDiamond, I've passed this to our development team!