Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
Hrvoje Cavrak committed Dec 29, 2023
1 parent a03e76f commit ce27f33
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,11 +166,24 @@ It wasn't tested with those, so surprises are always possible but in theory it s
## Shortcomings

- NOTE: Both computers need to be connected and powered on for this to work (as each board gets powered by the computer it plugs into).
- So far it only supports boot protocol, report protocol parsing under development, so advanced fast-polling mice might not be fully supported at first
- Code needs cleanup, some refactoring etc.
- Occasional bugs and weird behavior.
- Not tested with a wide variety of devices, I don't know how it will work with your hardware.
- Pico-PIO-USB was patched to support controlling keyboard LEDs, normally this would be handled by TinyUSB in host mode.

## [Update 29-Dec-2023]

So, what's the deal with all the enthusiasm? I can't believe it - please allow me to thank you all! I've never expected this kind of interest in a simple personal project, so the initial features are pretty basic (just like my cooking skills) and mostly cover my own usecase. Stay tuned for firmware updates that should bring wider device compatibility, more features and less bugs. As this is a hobby project, I appreciate your understanding for being time-constrained and promise to do the best I can.

Planned features:
- Proper TinyUSB host integration
- HID report protocol parsing, not just boot protocol
- Support for unified dongle receivers
- Support for USB hubs and single-sided operation
- Configurable screens
- ... and more!

## Disclaimer

I kindly request that anyone attempting to build this project understands and acknowledges that I am not liable for any injuries, damages, or other consequences. Your safety is important, and I encourage you to approach this project carefully, taking necessary precautions and assuming personal responsibility for your well-being throughout the process. Please don't get electrocuted, burned, stressed or angry. Have fun and enjoy!
Expand Down

0 comments on commit ce27f33

Please sign in to comment.