-
Notifications
You must be signed in to change notification settings - Fork 12
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
Feature: Improve docs #4
Comments
Thanks for the issue! I am aware the docs aren't totally complete, and I appreciate the pointers on where the docs need some work. I do plan on adding more information about setting up specific drivers to the user docs, along with adding doc comments for the macros (and improving the API reference in general). At the moment, the only information about drivers is just the "Available Drivers" section, which I know may not be enough information for a first-time user. As for that macro error message you pasted, looks like I forgot to add the rumcake/rumcake-macros/src/hw/nrf.rs Lines 88 to 141 in 30bdb70
rumcake/rumcake-macros/src/hw/rp.rs Lines 93 to 126 in 30bdb70
For the diodeless matrix, this is something that is supported by |
Added support for direct pin / diodeless matrix: https://univa.github.io/rumcake/getting-started/matrix-and-layout/#direct-pin-matrix-diodeless-matrix Let me know if you have any issues getting this to work. |
Type of Feature Request
rumcake
featurerumcake
featuresrumcake
featuresDescription
First of all thanks for putting this project together. I've been looking for an option to get things working for my latest keyboard, and this looks like the closest I've got.
My current keyboard is a ferris/sweep with one half with an ELITE-pi (aka an RP2040), and the other half is a nice!nano board. Both of these boards are connected via a wired connection on a TRRS cable. The reason this project seems like a great option is;
This project seems to be the perfect fit, but after a few hours of reading through the source code I'm kind of stumped as to how all the pieces fit together. The documentation that is available it seems like it's very well written but there are some holes where docs could probably be better. I'm fully aware that writing docs can be quite dry and boring, so I'm just going to ask some questions and if you have time to respond I'll write them up into some docs as I go. Here are my questions;
Setting wired serial connection between split left/right
What are the parameters that I should be using with
rumcake::hw::mcu::setup_buffered_uarte
to implement the necessary settings for wired communication? Apart from the RX/TX pin args it's unclear what I should be using here. I've tried looking through the docs and source code inembassy
,nrf-hal
etc. But between all the macros and abstraction layer's I've kind of got a little lost. e.g. Here are one of the errors that I'm running into;TBH I'm not even sure if the arguments I've used here even make sense. So it could be that I'm just using the macro completely incorrectly.
Setting up non-matrix type keyboard pinouts
In the case that there is 1-gpio-pin per key, what should I be doing with the layouts? It's not entirely clear how to adapt the layout for non-diode-matrix keyboards.
The text was updated successfully, but these errors were encountered: